Crate Definition
Crate definition and its configuration. Crates use the GUI Extension system for all menu rendering (no legacy Bukkit inventory menus).Configuration
Id
The id of this entry.Name
The name of this entry.Data Artifact
Artifact storing crate data (openings, keys, etc.).Display Npc
NPC visually representing the crate.No Key Message
Message sent when the player has no key.Firework Colors
Colors of fireworks during opening.Firework Type
Type of the final firework.Rewards
Possible rewards when opening the crate.- Action: Entry triggering the reward.
- Name: Custom name of the reward.
- Lore: Description of the reward.
- Rarity: Rarity of the reward.
- Item: Item displayed in preview.
Milestones
Milestones offering additional rewards.- Openings: Number of openings required.
- Reward: Reward triggered at this milestone.
Rarities
Available rarities for rewards.- Name: Name of the rarity.
- Weight: Relative weight of rewards of this rarity.
Chance Lore
Line added to lore indicating obtaining probability. Placeholders:{chance}, {rarity}.
Rarity Lore
Line added to lore indicating reward rarity. Placeholders:{chance}, {rarity}.
Reward Slots
Slots where rewards are displayed (e.g. ‘2-10,15’). Rewards are paginated if they exceed the available slots.Icon
Icon representing the crate in the global menu.- X: Position X in the grid (0-8)
- Y: Position Y in the grid (0-5)
- Item: Item used as icon
- Name: Icon name (supports crate placeholders)
- Lore: Icon description (supports crate placeholders)
Menu Name
Name of the crate menu (supports crate placeholders).Preview
Crate preview settings (offsets, text display).Open Animation
Animation executed during opening.Hologram Lines
Hologram text displayed above the crate. Placeholders:{openings}, {keys}, {last_open}, {milestone}.
Buttons
Custom buttons positioned via XY grid in the crate menu.| Field | Type | Description |
|---|---|---|
type | Enum | Button type: INFORMATION, NEXT, PREVIOUS, FILL |
x | Int | Position X (0-8) |
y | Int | Position Y (0-5) |
item | Item | Custom button item |
name | Var<String> | Button name (supports crate placeholders) |
lore | List<Var<String>> | Button description |
action | Ref<TriggerableEntry> | Action triggered on click |
Note: FILL buttons automatically fill every empty slot in the menu. Only the first FILL button is used.
Gui Layout
GUI layout type for the crate reward menu. Options:PAGINATED (default), SCROLLABLE, FRAME, FLEX, SIMPLE.
Internal: /cratemenu Command
An internal Bukkit command /cratemenu routes GUI interactions:
/cratemenu open <crateId>— Opens a specific crate’s reward menu/cratemenu global— Opens the global crate listing/cratemenu trigger <actionId>— Triggers a button action
Placeholders
Crate placeholders are supported inmenuName, button name/lore, and icon name/lore:
%crate_<id>_keys%— Number of keys the player has%crate_<id>_keys_used%— Keys the player has used%crate_<id>_openings%— Times the player has opened this crate%crate_<id>_last_open%— Last opening timestamp%crate_<id>_milestone%— Current milestone progress