Overview#
Trinkets is a library and framework mod designed to provide a standardized accessory system for the Minecraft ecosystem. Unlike traditional accessory mods that come with a fixed set of slots, Trinkets is built on extreme flexibility, allowing modpack creators and developers to define their own slot groups and individual slots via data packs.
By default, the mod does not enable any slots. This design philosophy ensures that players are not overwhelmed by empty, useless slots; slots only appear when a mod that utilizes the Trinkets API is installed or when a user manually enables them through configuration. This makes it a core dependency for many popular equipment and utility mods.
Mechanics#
The Trinket Interface
When a mod adding trinkets is installed, a small icon appears in the player's survival inventory next to the player model. Clicking this icon opens the Trinkets inventory overlay. This interface displays all active slot groups. Hovering over a group icon will expand it to show the individual slots contained within that group.
Slot Groups and Slots
Trinkets organizes equipment into Groups and Slots:
- Groups: Broad categories that usually correspond to body parts (e.g., Head, Chest, Hand).
- Slots: Specific locations within a group where an item can be equipped (e.g., Necklace within the Chest group, or Ring within the Hand group).
Item Compatibility
Items are assigned to slots using Minecraft's tag system. For an item to be equippable in a specific slot, it must be included in the corresponding item tag: trinkets:tags/items/<group>/<slot>. For example, an item in trinkets:tags/items/chest/necklace can be equipped in the necklace slot.
Default Slots#
While Trinkets allows for infinite customization, it provides a set of standard slot definitions that most mods adhere to for maximum compatibility. Below are the default slot groups and the common slots they contain:
| Group | Slot | Common Use Cases |
|---|---|---|
| Head | Face | Goggles, masks, monocles |
| Head | Hat | Crowns, special helmets, cosmetic hats |
| Chest | Necklace | Amulets, pendants, charms |
| Chest | Cape | Capes, elytra-like items |
| Chest | Back | Backpacks, quivers, tanks |
| Legs | Belt | Tool belts, potion pouches |
| Feet | Aglet | Speed-boosting charms |
| Feet | Shoes | Slippers, specialized boots |
| Hand | Ring | Magical rings, power bands |
| Hand | Glove | Combat gloves, mining mitts |
| Offhand | Ring | Secondary rings |
| Offhand | Glove | Secondary gloves |
Data Formats#
Trinkets is entirely data-driven, meaning slots and entity configurations are handled via JSON files in data packs.
Slot Configuration
Slots are defined in data/<namespace>/trinkets/slots/<name>.json. A slot definition includes:
- Icon: The texture used for the slot in the UI.
- Priority: Determines the order in which slots appear.
- Size: The number of items the slot can hold (usually 1).
Entity Configuration
To determine which entities have access to which slots, Trinkets uses entity files located in data/<namespace>/trinkets/entities/<name>.json. By default, the mod provides a configuration for the player, but any living entity can be assigned trinket slots, allowing for complex mob equipment systems.
{
"entities": [
"minecraft:player"
],
"slots": [
"chest/necklace",
"hand/ring"
]
} Commands#
Trinkets includes administrative commands to manage player equipment and debug slot configurations. These are useful for server administrators and modpack developers.
| Command | Description |
|---|---|
/trinkets set <player> <group> <slot> <index> <item> |
Forces an item into a specific trinket slot on a player. |
/trinkets get <player> <group> <slot> <index> |
Returns the item currently equipped in the specified slot. |
/trinkets info <player> |
Lists all active slots and currently equipped trinkets for a player. |
Configuration#
The mod provides a client-side configuration file (trinkets-client.toml) which allows users to customize the visual experience of the accessory system:
- Show Trinket Button: Toggles the visibility of the trinket icon in the inventory.
- Button Position: Adjusts where the trinket button appears relative to the player model.
- Group Tooltips: Enables or disables detailed tooltips when hovering over slot groups.
- Quick Move: Configures how items are moved into trinket slots when shift-clicking from the main inventory.