📰 Reward Config Editing

#Edit Rewards

You can also edit the rewards through the configuration file if you prefer to manage everything manually.

#Reward Options

Each entry under rewards carries the reward's own settings alongside its items. Every one of them is also editable from Edit Reward, so the table below is mostly useful when generating crates outside the game or editing many rewards at once.

Option	Description
identifier	Unique id of the reward. Changing it loses the player progress tied to it.
enabled	Whether the reward can be won at all.
display-item	The item shown in the preview, never given to the player.
win-items	The items the player receives, numbered from '0'.
win-commands	Commands run when the reward is won.
weight	Chance share in Random mode. Higher means more often.
win-limits	How many times one player can win it. -1 is unlimited.
global-win-limit	How many times everyone combined can win it. -1 is unlimited.
guaranteed-win	Openings after which the reward is guaranteed. -1 disables it.
required-keys	Keys the reward costs in Selective mode.
required-permissions	Permissions a player must have for the reward to be available.
restricted-permissions	Permissions that prevent a player from winning the reward.
broadcast	Whether winning it announces the crate's broadcast message.
allow-win-message	Whether the winner gets a message.
notification-type	Where that message goes, CHAT or ACTION_BAR.
share-players-online	Whether every online player also receives the reward.

max-win caps how much of each list is handed out per win, picked at random, with -1 meaning the whole list:

max-win:
  item-amount: 1
  command-amount: -1

cooldowns holds the three reward cooldowns, in seconds. time-limited-expiry is written by the plugin to remember when the time limited window ends, and is not meant to be set by hand:

cooldowns:
  win-limit-cooldown: 0
  global-win-limit-cooldown: 0
  time-limited-cooldown: 0
  time-limited-expiry: 0

alternative-reward is the reward given once a limit is reached, with its own item, commands and toggles:

alternative-reward:
  enabled: false
  reward:
    item:
      material: DIAMOND_PICKAXE
      display-name: '&aAlternative Item'
      amount: 1
    virtual: false
    broadcast: false
    allow-win-message: true
    share-players-online: false
    commands: []

Setting virtual to true keeps the alternative item as a display only, so the player receives nothing but the commands still run.

#Format:

The following option is the method you can use for vanilla items.
Note: This option cannot be configured through the in-game editor, as the editor uses the bukkit format to also support custom properties and modded Items.

display-item:
  material: PAPER
win-items:
  '0':
    material: PAPER

#Material:

Allows you to set a material on your item.

material: TEXT

Supported material values:

• Vanilla (DIAMOND).
• HeadDatabase (hdb:id)
• ItemsAdder (itemsadder:namespace:id)
• Nexo (nexo:id)
• Mythic Items (mythicitem:id)
• MMOItems (mmoitem:type:id )
• ExecutableItems (executableitem:id)
• CraftEngine (craftengine:id)

• Materials Link

#Hooked Materials

A hooked material is the hook name, a colon, then the id the other plugin knows the item by. Only the first colon separates the two, so everything after it reaches that plugin exactly as written.

Hook	Value	Example
ItemsAdder	itemsadder:namespace:id	itemsadder:medieval_crates:crate_key
MMOItems	mmoitem:type:id	mmoitem:SWORD:cutlass
Nexo	nexo:id	nexo:ruby_sword
CraftEngine	craftengine:id	craftengine:default:ruby_sword
Mythic Items	mythicitem:id	mythicitem:excalibur
ExecutableItems	executableitem:id	executableitem:magic_wand
HeadDatabase	hdb:id	hdb:1234

ItemsAdder and MMOItems ids are built from two parts of their own, so those values have three parts in total. itemsadder:crate_key sends only crate_key to ItemsAdder and resolves to nothing, and an MMOItems value with no type is rejected. For the rest, pass the id exactly as the plugin registers it, namespace included where it has one.

material: itemsadder:medieval_crates:crate_key

The same values work in every material field of the plugin, the menus included.

#Display Name

Allows you to set a display name on your item.

display-name: '&eExample Reward'

#Lore:

Allows you to set a custom lore on your item.

lore:
- '&cLine 1'
- '&eLine 2'
- '&aLine 3'

#Model Data:

Allows you to set custom model data on your item.

model-data: 1000

#Item Model:

Allows you to set a custom Item Model (the modern resource-pack item model component) on your item.

item-model: 'minecraft:custom_paper'

#Amount:

Allows you to set a fixed stack size on your item.

amount: 1

#Enchants:

Allows you to set enchants on your item.

enchants:
- 'PROTECTION:1'
- 'UNBREAKING:1'

• Enchantsments Link

#Item Flags:

Allows you to set item flags on your item, to hide certain tooltip sections (enchants, attributes, "unbreakable", etc).

flags:
- 'HIDE_ENCHANTS'

• item-flags is accepted as an alias, used when flags is absent.
• Item Flags Link

#Tooltip Style:

Allows you to set a custom tooltip style/texture (resource-pack defined) for the item's tooltip box.

tooltip-style: 'minecraft:gui/sprites/widget/inventory_tooltip'

#Enchantment Glint Override:

Allows you to force the enchantment glint (the shimmering/glowing effect) on or off, independently of whether the item is actually enchanted.

enchantment-glint-override: true # Boolean (`true`/`false`)

#Banner Meta:

Allows you to add banner patterns to your item. Works on banners, and on shields (and other blocks that carry banner data).

banner-meta:
- 'RED;STRIPE_BOTTOM'
- 'WHITE;CROSS'

• Each entry follows the format <DyeColor>;<PatternType>.
• DyeColor Link / PatternType Link

#Armor Trim (Material & Pattern):

Allows you to apply an armor trim to your item, by setting both the trim material and the trim pattern.

trim-material: IRON
trim-pattern: DUNE

• Both options must be set together.
• Armor Trim Materials / Armor Trim Patterns

#Potion Effects:

Allows you to add custom potion effects to a potion item.

potion-effects:
- 'speed;1200;1'
- 'regeneration;600;0'

• Each entry follows the format <PotionEffectType>;<duration in ticks>;<amplifier>.
• Potion Effect Types Link

#RGB:

Allows you to set a custom color on your item, using raw RGB values.

rgb: '38, 192, 210'

• Format: R, G, B (each 0-255). Applies to leather armor, potions, maps and firework effects.

#Item Config Example

The following is an example of a reward with its display item and the actual reward.

  '2':
    identifier: reward_1759509999284
    display-item:
      material: PAPER
      # Legacy colors support
      display-name: '&#C00BD6Paper'
      lore: 
      - '&cCustom Paper Item'
      model-data: 1000
      enchants:
      - 'PROTECTION:1'
      flags:
      - 'HIDE_ENCHANTS'
    win-items:
      '0':
        material: PAPER
        # Mini Message Support
        display-name: '<gradient:#C00BD6:#FD2177>Paper</gradient>'
        lore: 
        - '<gradient:#C00BD6:#FD2177>Custom Paper Item</gradient>'
        model-data: 1000
        enchants:
        - 'PROTECTION:1'
        flags:
        - 'HIDE_ENCHANTS'