This project is for the Forge mod loader. To see its counterpart for the Fabric mod loader, please go here.
Overview
Curios is a flexible and expandable accessory/equipment API for users and developers. The purpose is to provide functionality for developers to add extra accessory/equipment slots in a convenient and compatible manner, as well as to give users the ability to configure these slots to their preferences. By default, Curios does not add any content except for an inventory GUI. There are no slots and only two items, the latter only being available through the Creative menu and primarily serving as examples for developers to use when coding their own integration.
Features
- Expandable equipment slots through a central library. New equipment slots can be made and managed easily through an identifier registry. Identical identifiers will be merged together to avoid functional redundancies and provide maximum compatibility to potential items, while unique identifiers can still be used to mark special types when appropriate.
- Slots are only made on-demand. There are no slots included by default, all slots are created only as needed. This reduces instances where one or more superfluous slots are present without any suitable items to go into the slot.
- Slots are completely customizable and manipulable. Slots can have custom backgrounds, different sizes, and can even be disabled or hidden by default. But how would a player even access disabled slots? Through the API, developers can access functions to enable/disable a player's slots or add/remove a certain number of slots of a given type.
- Flexible item->curio relations using the vanilla tag system. Potential curios are selected through the vanilla tag system, which means that categorizing items into curio types is as easy as creating a .json file in the data/curios/tags folder. Items can be categorized into as many curio types as you want as long as they're tagged in the appropriate files, and these settings can even be overridden entirely. For more information, see the vanilla tag system.
- Complete integration with other inventory mechanics. Mending and Curses will work with all applicable items equipped in the curio slots. There are also various minor features for developers that make it simpler to integrate their current items or mechanics into the curio system.
- Accessible from a single GUI. Curios comes with its own GUI accessible from the inventory that shows all of the available slots to a player. This allows players to see all of the extended equipment slots in a central location without needing to access different inventory GUIs. However, developers can still provide their own GUIs for their mod-specific slots if they want. The default keybinding for the GUI is 'g'.
Documentation
How to make a new tag for item, that I can put it in some place?
is there any way to force the amount of curio slots, i have many mods and for some reason one of them made me have 22 ring slots.
hey how to change the back slot into 3 slots
The curios-server.toml should automatically generate once you load a world with Curios installed. It's going to be located in:
"%appdata%\roaming\.minecraft\saves\<your world name here>\serverconfig"
That's the file you need to use. You can also copy the "curios-server.toml" file to your "defaultconfigs" file [found in the .minecraft folder], to apply your slot configurations globally, without having to edit the config in each world you use. Do remember that your datapack you make to add in slot information will need to be copied into each instance of "datapacks" in each of world's save folder (I don't think there's a "universal" datapacks folder, and I don't know if you can just create one in the root folder and expect it to work).
You can make a "curios-server.toml" file in either the "serverconfig" or "defaultconfigs" folder if one still doesn't generate on loading your world with Curios API installed. Just make sure to follow the FAQs on the wiki.
In reply to PSU_Terra:
NOPE.avi
First, I just wanted to say thank you, C4, for making an API that lets users customize the slots we can add on. It's a unique addition, and one I'm still trying to use to it's fullest.
I've been trying to add in slots to support "must be in your hotbar" mod items, to limited success. I had mixed success with the individual rings from the Gobber mod (such as the "Ring of Attraction" and "Ring of Repair" working perfectly, but not "Ring of Growth"), and the "Curio of Undying" mod works perfectly.
I've followed the FAQs for adding in slots, and properly tagging items for the slots I add (that part is working perfectly). However, the one mod I wanted to add to slots, and have active, isn't cooperating. I'm trying to get the "Inventory Pets" pets to stay "active" when placed into slots. They go into the slots without any issue at all, they just refuse to activate.
I think it might be due to the intended use being that the player has to have them in their Hotbar (nowhere else in personal inventory) to function.
I've tested every slot available by default (literally), and while they'll go into whichever slot I tag them in, and create a .json file for, they refuse to activate. They just sit there in the assigned slot, and do nothing.
Is there something I'm missing, or is it simply not possible to trigger "in hotbar" behavior from a slot? I would have figured the "Charm", "Hand" or even "Curio" slots would trigger hotbar behavior, especially when the Totem mod worked perfectly in the Charm slot.
I also noticed that when I added the Glass Block (default vanilla) to the Head Slot, it would allow me to equip it, but neither the Cosmetic or Head Slot rendered the Glass Block on my head. Additionally, I enchanted a Glass Block (just out of curiosity) to see if Helmet based enchantments carried over from the Head Slot, but nothing applied. The enchantments were there, the block was glowing, but no effects happen.
Any help/suggestions would be greatly appreciated. If this isn't possible, I'd rather know, than to start adding in more custom slots, and drive myself crazy trying to figure out why "hotbar", "pet", and any other slots I try to create won't work either.
Thanks!
In reply to PSU_Terra:
This is a common mistake that users make. While you can make custom slots and add items to them, the issue is that items cannot magically activate just because they are in a Curios slot. They have to be coded for functionality. If an item is coded to only work in the hotbar, it'll only work in the hotbar. The Curio of Undying mod works because there's additional functionality coded to check all of the Curio slots for the totem. It's the same case with trying to render items. If there's no code that tells it how to render from a Curio slot, it won't render anything.
The primary type of item that would retain functionality in Curio slots automatically are items that are coded in a very particular way, which is rare. You'll likely find the most success using custom slots with items that already have Curios integration coded in some way.
In reply to TheIllusiveC4:
Thanks for the quick reply. That's explains why I couldn't make it work with Inventory Pets, or render blocks on my head. I thought I was missing some simple step, or forgetting to add in another tag option.
If only I knew more about Java and coding in it, I could make a patch or something. Ah well.
I appreciate you answering my questions, because now that I know how it needs to be done, it at least gives me the option to stop tinkering with it, and be happy with the mods that work correctly with your API.
HELP what if I don't have a curios-server.toml should I make one? or what
image
help
Is there a way that I can edit the config of Curios or any of the mods to give me more slots for rings, charms, etc.? I've come to the problem where I have quite a few mods but not enough slots for all the rings and accessories I would like.
In reply to max_anthrax:
https://github.com/TheIllusiveC4/Curios/wiki/How-to-Use:-Users
In reply to TheIllusiveC4:
When I change the config according to instructions or put it in my defaultconfig folder it doesn't allow me to even open up my old worlds or make new ones. Here's what i typed in the config if it'll help you figure out the problem:
#List of curio slot type settings
curiosSettings = []
[[curiosSettings]]
identifier = "ring"
size = 30
lock = false
visible = true
[[curiosSettings]]
identifier = "charm"
size = 15
lock = false
visible = true
[[curiosSettings]]
identifier = "necklace"
size = 20
lock = false
visible = true
[[curiosSettings]]
identifier = "back"
size = 6
lock = false
visible = true
[[curiosSettings]]
identifier = "hands"
size = 2
lock = false
visible = true
[[curiosSettings]]
identifier = "belt"
size = 5
lock = false
visible = true
[curiosSettings]]
identifier = "head"
size = 5
lock = false
visible = true
For my modpack, Create on a Potato PC I have added a few slows. However, I am having some difficulty with a couple of issues:
Thank you,
CM
In reply to ClaudiusMinimus:
Somehow I missed the "
size = 2", but I have not been able to add a label or image to the GUI. Any help would be apprecitated. BTW: I have tried making a resource pack, but must be doing something wrong.In reply to ClaudiusMinimus:
This was answered here https://github.com/TheIllusiveC4/Curios/issues/132
Some items dont stay in their slots after death and re-login
egs are - items for Curios slot alone (works with any slot)
- items that have multiple types (ring. necklace. bracelet ECT
i hope you will read this and work on the few that can we worked on. i enjoy this mod and i hope to see some of these issues resolved.
In reply to geartestv2:
Please report all issues to the issue tracker following the bug report template.
I am trying to play with spartan weaponry installed and it says that spartan weaponry requires curios version 4.0.3.0 or above. I already had a version higher than that one, but it would not load. i eventually tried the exact version that the message mentioned, but it said, and this is EXACTLY what it said: Mod spartanweaponry only supports curios 4.0.3.0 or above currently curios is 1.16.4-4.0.3.0. i had the EXACT same version but it would not load
In reply to esnake4248:
Please refer to this issue on the issue tracker for more information.