📂 Crate Configuration File

#Example Crate

Each crate has its file inside the crates folder. Check the default structure of a crate:

enabled: true
identifier: example1
item:
  material: custom:example_crate
  amount: 1
display-name: '&eExample #1'
block-material: BROWN_WOOL
engine: VANILLA_BLOCK
open-cost:
  engine: NONE
  amount: 0.0
  currency: ''
open-cooldown: 0
simultaneous-openings: true
preview-item: false
permission:
  required: false
  permission: phoenixcrates.crate.example1
idle-effects:
- CIRCLE;{REDSTONE;#ff0000;0.0;1.0;2.0;0.0;0.0;1}
opening-animation:
  pre-open: DEFAULT
  open: SPOTLIGHT_GUI
  display: NONE
hologram:
  type: BUILTIN
  offset: 0.0
  lines:
  - '&e&l%name%'
  - ''
  - '&aRight &7Click to open'
  - '&cLeft &7Click to preview'
menus:
  rewards: default_rewards_preview
  select-reward: default_select_reward
  rerolls: default_crate_reroll
  preview-actions: []
key-required: true
linked-keys-ids:
- example1
allow-open-command: true
broadcast:
  message: '&ePlayer &a%player% &ejust got &6"%reward%" &ereward from the crate &6%crate%&e!'
max-win-rewards: 0
rewards-mode: RANDOM
rewards:
  '0':
    enabled: true
    identifier: reward_1783907600221
    display-item:
      material: custom:example_crate
      amount: 4
    win-items:
      '0':
        material: custom:grass_block
        amount: 1
    win-commands: []
    broadcast: false
    weight: 100.0
    win-limits: -1
    global-win-limit: -1
    cooldowns:
      win-limit-cooldown: 0
      global-win-limit-cooldown: 0
      time-limited-cooldown: 0
      time-limited-expiry: 0
    guaranteed-win: -1
    required-keys: 1
    allow-win-message: false
    notification-type: CHAT
    share-players-online: false
    restricted-permissions: []
    required-permissions: []
    max-win:
      item-amount: 1
      command-amount: -1
    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: []
guaranteed-reward-type: DISABLED
reroll:
  enabled: false
  free-rolls: 0
  groups:
    '0':
      namespace: common
      rerolls: 3
  replay-animation: false
  skip-same-reward: false
extra-settings:
  animation:
    display-item-position:
      x: 0.0
      y: 2.0
      z: 0.0
    display-item-name-position:
      x: 0.0
      y: 0.3
      z: 0.0
    skip-on-esc: false

#Idle Effects

The idle-effects lines pack a whole particle effect into one string, in the form TYPE;{PARTICLE;COLOR;offsetX;offsetY;offsetZ;spread;velocity;amount}. Each field is explained on the Idle Animations page.

#Item Storage

Every crate file starts with an internal-storage section holding the raw items the crate uses, each under a name that the rest of the file points at with custom:<name>. It is written by the plugin, so a crate item, a reward item or a display item edited from the editor ends up there instead of being repeated inline.

Editing an item by hand means editing its entry in that section. Removing an entry that something still points at leaves that part of the crate without an item.

#Add-on Sections

Installed add-ons append their own section to every crate file, and Mass Opening also adds its two menu names into the existing menus section. A file only grows once the add-on has run for the first time, and deleting a section makes it come back with its defaults.

mass-opening:
  enabled: false
  presets:
    first:
      enabled: true
      amount: 6
  open-all:
    enabled: true
    max-amount: 100
lootbox:
  enabled: false
menus:
  mass-reroll: default_crate_mass_reroll
  mass-selective: default_crate_mass_selective