Curios API — Guide

User Interface

The primary way to interact with Curios is through the expanded inventory GUI.

Accessing the Menu

Players can access the Curios equipment screen by clicking the orange ring icon located in the top-left corner of the player's character preview in the standard inventory. Alternatively, the default keybinding to open the Curios GUI directly is 'G'.

The Curios Screen

When opened, the screen displays all currently active slots. If a player has no items that fit into a specific slot type and no mod has force-enabled that slot, it may remain hidden to keep the interface clean. The GUI supports scrolling if the number of active slots exceeds the display area.

Slot Types

Curios uses a system of identifiers to categorize slots. While mods can define any custom slot, the following are the standard presets often used across the ecosystem:

Slot Identifier	Description	Default Icon
`back`	Used for capes, backpacks, or quivers.
`belt`	Used for tool belts or sash-style items.
`body`	Used for tabards or chest-worn accessories.
`charm`	Used for small magical trinkets or totems.
`head`	Used for goggles, crowns, or masks.
`necklace`	Used for amulets and pendants.
`ring`	Used for rings (often allows multiple slots).
`hands`	Used for gloves or bracelets.
`bracelet`	A specific slot for wrist-worn items.

Mechanics

Attribute Modifiers

Curios can grant players attribute modifiers (like increased health, attack damage, or movement speed) while equipped. These modifiers are visible in the item's tooltip, similar to vanilla armor.

Drop Rules

By default, Curios follow the same rules as the player's inventory upon death. If keepInventory is false, curios will drop on the ground. However, Curios API provides a dropRules configuration to override this behavior for specific slots or items (e.g., making certain items always stay with the player).

Cosmetic Slots

Some slot types can be configured to have a "Cosmetic" toggle. This allows a player to equip an item for its stats in the functional slot while wearing a different item in the cosmetic slot to change their appearance.

Data Packs & Custom Slots

Users and modpack creators can add custom slots without writing code by using a Data Pack.

To create a custom slot, place a JSON file in: data/curios/curios_slots/[slot_name].json

Example Slot JSON:

{
 "size": 1,
 "operation": "set",
 "icon": "curios:gui/slots/ring",
 "priority": 10,
 "add_cosmetic": true
}

This system allows for infinite customization, enabling slots for specific mod mechanics like "Spell Focus" or "Quiver."