From fdc077ea64cb86c31d229f6ac8ba8b4bda7ae63f Mon Sep 17 00:00:00 2001 From: jss2a98aj Date: Thu, 29 May 2025 17:18:06 -0400 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 42e6a28..bcad532 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,36 @@ -Baubles -======= +# Baubles Expanded -A mod api that adds up to twenty bauble slots to the players inventory. +A fork of the 1.7.10 version of Azanor's Baubles mod with extra features. Backwards compatible with mods made using the original. Baubles Expanded adds the same four slots as the original out of the box, but can have up to twenty in total. Other mods can add entirely new slot types and allow a bauble to be placed in more than one type of slot. -The mod has no real content - the idea is that other mods will use this one and its API to add their own baubles. +Downloads are available from tags and on [Modrinth](https://modrinth.com/mod/baubles-expanded). -The slots added by default are an amulet, belt, and two ring slots. +# New Features + +## For Users + +- Override the slots assigned by default through the config. +- Set Soulbound enchantment IDs in the config so moded Soulbound enchantments function as expected. Works great with [Ars Magica](https://github.com/TCLProject/ArsMagica2-5)! +- Backwards compatibility with mods made for the original. + +## For Modders + +- Register brand new slot types. +- Add slots to the inventory. +- Create baubles that can go in more than one slot type. + +# Mods Using New Features + +- [Et Futurum Requiem](https://github.com/Roadhog360/Et-Futurum-Requiem) (optional wing slot for the Elytra) + +# Known Issues + +- Due to a vanilla bug enchanted items can cause inventory slots and items to render incorrectly. This is fixed by [BugTorch](https://github.com/jss2a98aj/BugTorch). +- Replacing the original four slots or adding more slots of the those types may reduce backwards compatibility. +- The Bauble Case item from Botania cannot access more than the first four slots. This will be fixed in an upcoming fork of Botania. + +## Special Thanks + +- Azanor and contributors for creating and maintaining the original mod for as long as they did. +- TechnoParadox for creating the icon. Baubles is distributed under the Attribution-NonCommercial-ShareAlike 3.0 Unported (CC BY-NC-SA 3.0) license. -