Plugin Config
This is the server-wide config for EcoCrates, config.yml, found at /plugins/EcoCrates/config.yml. It holds storage, permission multipliers, the reroll and keys GUIs, and the shared animation and roll settings. Apply changes with /ecocrates reload.
Default config.yml
# Even if eco is set up to use a database, you can
# force EcoCrates to save to local storage to disable
# cross-server sync.
use-local-storage: false
no-key-velocity: 1.5 # The speed at which a player should be launched away from a crate if they try to open it without a key. Set to 0 to disable.
track-player-keys: false # If an NBT tag should be added to keys that links them to a player - will prevent stacking some keys.
chance-decimal-places: 2 # How many decimal places to show in the %chance% placeholder. Increase this to distinguish very rare rewards from each other.
# If a reward allows permission multipliers, the weights
# will be multiplied by highest-priority multiplier that a player
# has permission for - i.e. if a player has both vip and mvp permissions,
# than they'll have the mvp one applied as it has a higher priority.
permission-multipliers:
- permission: ecocrates.multiplier.vip
multiplier: 1.5
priority: 1
- permission: ecocrates.multiplier.mvp
multiplier: 2
priority: 2
# The reroll GUI, shown after a win when the crate allows rerolling.
# Use %price% in the reroll button's name/lore to show the cost of the next reroll (empty for free rerolls).
reroll:
rows: 3 # Rows in the reroll GUI
mask: # Decorative filler items
items:
- black_stained_glass_pane
- green_stained_glass_pane
pattern:
- "122211111"
- "120211011"
- "122211111"
title: "Accept your reward?" # The GUI title
accept: # The button to keep the current reward
row: 2
column: 3
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
reroll: # The button to reroll for a new reward
row: 2
column: 7
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
item: orange_stained_glass_pane
name: "&6Reroll"
lore:
- "&fNot happy with your item?"
- "&fClick to try again for"
- "&fa chance at something else!"
- ""
- "&fCost: &e%price%" # Cost of the next reroll
# The menu shown after a roll that shows several rewards at once.
# Each reward is rerolled on its own; closing the menu accepts every reward.
multi:
title: "Accept your rewards?" # The GUI title is shown at the top.
rows: 4 # The number of rows in the menu.
mask: # Decorative filler items fill the empty slots.
items:
- black_stained_glass_pane
- green_stained_glass_pane
pattern:
- "122222221"
- "100000001"
- "100000001"
- "122202221"
# The slots the rewards show in, in order. Rewards beyond the last slot are still given.
rewards:
- { row: 2, column: 2 }
- { row: 2, column: 3 }
- { row: 2, column: 4 }
- { row: 2, column: 5 }
- { row: 2, column: 6 }
- { row: 2, column: 7 }
- { row: 2, column: 8 }
- { row: 3, column: 2 }
- { row: 3, column: 3 }
- { row: 3, column: 4 }
- { row: 3, column: 5 }
- { row: 3, column: 6 }
- { row: 3, column: 7 }
- { row: 3, column: 8 }
accept: # The button to keep every reward.
row: 4
column: 5
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
item: 'lime_stained_glass_pane name:"&aAccept all"'
# Lines added to the lore of each reward that can be rerolled. %price% shows the cost of its next reroll.
reroll-lore:
- ""
- "&fClick to reroll this reward"
- "&fCost: &e%price%"
# Options for crates and pouches that give more than one reward per open.
# A crate or pouch can override any of these in its own multi-reward section.
multi-reward:
# How rolls with no multi-reward animation show several rewards.
# sequential: the roll plays once per reward, one after another.
# primary: the roll plays for the first reward, then the bonus rewards are given straight after.
fallback: sequential
# If bonus rewards can be rerolled at all.
bonus-rerollable: true
# How bonus-chances combine.
# overall: each entry is the chance of getting at least that many rewards.
# chained: an entry is only rolled if the one before it hit.
# independent: each entry rolls on its own; the number of hits is the bonus count.
bonus-chance-mode: overall
# The confirm GUI, shown before a player pays to open a placed crate. Set enabled to false to charge straight away.
pay-to-open-confirm:
enabled: true # If players must confirm in a GUI before paying to open a crate.
rows: 3 # Rows in the confirm GUI
mask: # Decorative filler items
items:
- black_stained_glass_pane
pattern:
- "111111111"
- "110111011"
- "111111111"
title: "Open %crate%?" # Supports %crate% and %price% placeholders.
confirm: # The button that pays and opens the crate
row: 2
column: 3
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
item: lime_stained_glass_pane
name: "&aConfirm"
lore:
- "&fOpen %crate% &ffor &e%price%" # Supports %crate% and %price% placeholders.
cancel: # The button that closes the GUI without paying
row: 2
column: 7
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
item: red_stained_glass_pane
name: "&cCancel"
lore: [ ]
custom-slots: [] # Custom GUI slots; see https://hub.auxilor.io/wiki/eco/pages
# The /ecocrates keys GUI that lists a player's keys.
keygui:
rows: 3 # Rows in the keys GUI
mask: # Decorative filler items
items:
- black_stained_glass_pane
pattern:
- "111111111"
- "110101011"
- "111111111"
title: "Your Keys (%page%/%max_page%)" # Supports %page% and %max_page% placeholders.
page-change-sound: # The sound played when changing pages. Remove or set enabled to false to disable.
enabled: true
sound: ui.button.click
pitch: 1.0
volume: 1.0
forwards-arrow: # The arrow for switching to the next page.
item: arrow name:"&fNext Page" # Shown when there is a next page
item-inactive: gray_dye name:"&7Next Page" # Shown on the last page. Remove to hide the button instead.
row: 2
column: 9
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
backwards-arrow: # The arrow for switching to the previous page.
item: arrow name:"&fPrevious Page" # Shown when there is a previous page
item-inactive: gray_dye name:"&7Previous Page" # Shown on the first page. Remove to hide the button instead.
row: 2
column: 1
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
custom-slots: [] # Custom GUI slots; see https://hub.auxilor.io/wiki/eco/pages
# Particle animations used by placed crates; referenced by name in a crate's placed.particles.
animations:
spiral:
spirals-per-second: 0.5 # Full spirals completed per second
rises-per-second: 0.25 # Vertical rises per second
radius: 1.5 # Spiral radius in blocks
height: 1 # Total rise height
count: 1 # Particles spawned per step
double_spiral:
spirals-per-second: 0.25
rises-per-second: 0.125
radius: 1.5
height: 1
count: 1
circle:
spirals-per-second: 0.5
radius: 1.5
height: 1
count: 1
twirl:
spirals-per-second: 0.5
ticks: 80 # Total ticks for one twirl cycle
small-radius: 0.2 # Radius at the tight end
large-radius: 1.2 # Radius at the wide end
start-height: 2 # Starting height of the twirl
end-height: 0.7 # Ending height of the twirl
count: 1
tilted_rings:
spirals-per-second: 0.5
radius: 1.5
y-offset: 1 # Vertical offset of the rings
x-offset: 1 # Horizontal offset of the rings
count: 1
# Settings for each roll animation; pick one per crate with the crate's roll option.
rolls:
# hide-placed-crate hides the placed crate's hologram and preview item from the
# player who is rolling, for the duration of the roll. Only applies when opening
# a physically placed crate, and only to the player opening it.
csgo:
filler: black_stained_glass_pane name:"" # Item filling non-selected slots
selector: lime_stained_glass_pane name:"" # Item marking the selected slot
bias: 0.65 # How strongly the scroll eases toward the winner, 0 to 1
scrolls: 35 # Number of items scrolled past before stopping
max-delay: 25 # Max ticks between scroll steps near the end
flash:
duration: 80 # Total ticks the flash runs
wait: 20 # Ticks held on the winner before closing
hide-placed-crate: false
cycle:
duration: 80 # Ticks spent cycling through display rewards
wait: 20 # Ticks held on the winner before finishing
interval: 5 # Ticks between each item swap
height-offset: -1.0 # Offset from the crate's random-reward height the item floats at
hide-placed-crate: true
encircle:
spin-time: 100 # Ticks the items spin
reveal-time: 80 # Ticks the winner is revealed for
items: 12 # Items in the ring
radius: 3 # Ring radius in blocks
height: 1 # Height above the player
spins-per-second: 0.5 # Ring rotation speed
rise-velocity: 0.05 # Upward speed of items
spin-velocity: 0.4 # Per-item spin speed
reveal-velocity: 0.2 # Speed the winner rises on reveal
hide-placed-crate: false
elimination:
candidates: 7 # Rewards on show, including the winner; capped at 7
interval: 12 # Ticks between each elimination
reveal-time: 30 # Ticks the winner is left on screen
filler: black_stained_glass_pane name:"" # Decorative filler items
eliminated: red_stained_glass_pane name:"&cEliminated!" # Shown in place of a knocked out reward
pick:
boxes: 3 # Number of boxes to choose from; capped at 7
solo-reveal-time: 25 # Ticks only the picked box is open for, before the rest open
reveal-time: 40 # Ticks the opened boxes are left on screen after the rest open
auto-pick: 200 # Ticks before a box is picked for the player
title: "Pick a box!" # The GUI title; supports %crate%
box: chest name:"&e&lClick to pick!" # The face-down box item
filler: black_stained_glass_pane name:"" # Decorative filler items
choose:
reveal-time: 40 # Ticks the GUI stays open after picking, before the crate finishes
auto-pick: 200 # Ticks before a reward is picked for the player
title: "Choose your reward! (%page%/%max_page%)" # The GUI title; supports %crate%, %page%, %max_page%
mask:
items: # Decorative filler items, indexed by the digits used in pattern
- gray_stained_glass_pane
- black_stained_glass_pane
pattern: # 0/i are open slots, other digits are filler items by index; i marks a reward slot
- "222222222"
- "211111112"
- "1iiiiiii1"
- "211111112"
- "222222222"
page-change-sound: # The sound played when changing pages. Remove or set enabled to false to disable.
enabled: true
sound: ui.button.click
pitch: 1.0
volume: 1.0
forwards-arrow: # The arrow for switching to the next page
item: arrow name:"&fNext Page"
item-inactive: gray_dye name:"&7Next Page" # Shown on the last page. Remove to hide the button instead.
row: 5
column: 6
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
backwards-arrow: # The arrow for switching to the previous page
item: arrow name:"&fPrevious Page"
item-inactive: gray_dye name:"&7Previous Page" # Shown on the first page. Remove to hide the button instead.
row: 5
column: 4
locations: [ ] # Optional list of row/column slots; if set, the button shows in each of them instead of row/column
match:
to-match: 2 # Copies of the same reward needed to win; losers get at most one fewer
min-scratches: 3 # The winning set can never complete before this many scratches
reveal-time: 40 # Ticks the finished card is left on screen
auto-scratch: 100 # Ticks of no clicking before a card is scratched for the player
title: "Find a pair!" # The GUI title; supports %crate%
card: gray_stained_glass_pane name:"&e&lScratch!" # The unscratched card item
filler: black_stained_glass_pane name:"" # Decorative filler items
hologram:
duration: 80 # Ticks spent cycling through rewards
wait: 20 # Ticks the winner is held before finishing
interval: 5 # Ticks between each name swap
height: 1.5 # Height above the crate the hologram sits at
rolling: # Lines shown while rolling; supports %reward%
- "&8>> &f%reward% &8<<"
winner: # Lines shown once the winner is picked
- "&a&lYou won!"
- "&f%reward%"
hide-placed-crate: true
vortex:
items: 8 # Items in the funnel, including the winner
start-radius: 3.0 # Radius the funnel starts at
end-radius: 0.4 # Radius the funnel closes to
start-height: 0.5 # Height the funnel starts at
end-height: 2.5 # Height the funnel finishes at
spins-per-second: 1.0 # Funnel rotation speed
duration: 120 # Ticks the funnel takes to close
eject-velocity: 0.6 # Speed losers are thrown out at
reward-hold-time: 25 # Ticks the winner is held at the top
timeout: 400 # Safety cap in ticks; ends the roll if it never resolves
hide-placed-crate: false
roulette:
items: 8 # Items in the ring, including the winner
radius: 2.5 # Ring radius in blocks
height: 1.0 # Height the ring sits at
steps: 32 # Positions the cursor moves through before stopping
bias: 0.65 # How strongly the cursor eases to a stop, 0 to 1
max-delay: 12 # Max ticks between cursor steps near the end
reveal-time: 30 # Ticks the winner is left glowing
timeout: 400 # Safety cap in ticks; ends the roll if it never resolves
hide-placed-crate: false
strike:
height: 2.0 # Height the item rises to
rise-time: 30 # Ticks spent rising
hang-time: 15 # Ticks held at the top before the strike
reveal-time: 25 # Ticks the winner is left after the strike
interval: 5 # Ticks between each item swap on the way up
hide-placed-crate: false
delivery:
entity: allay # The courier; any eco entity lookup, e.g. allay, vex, bee
spawn-distance: 5 # Blocks behind the crate the courier appears
spawn-height: 1.5 # Height above the crate it appears at
speed: 0.25 # Blocks travelled per tick
hover-height: 1.4 # Height above the player it delivers at
hand-over-time: 25 # Ticks it hovers before handing the reward over
timeout: 400 # Safety cap in ticks; ends the roll if it never arrives
hide-placed-crate: false
orbit_collapse:
items: 8 # Items in the orbit, including the winner
radius: 2.5 # Orbit radius in blocks
height: 1.5 # Height the orbit sits at
rise-velocity: 0.4 # Speed items move out to the orbit
orbit-velocity: 0.4 # Speed items chase their orbit position
collapse-velocity: 0.25 # Speed items fall inwards at the end
spins-per-second: 0.75 # Orbit rotation speed
orbit-time: 100 # Ticks the items orbit for
reward-hold-time: 30 # Ticks the winner is held at the centre
timeout: 400 # Safety cap in ticks; ends the roll if the items never settle
hide-placed-crate: false
sky_drop:
launch-height: 6 # Height the winner rises to
rise-velocity: 0.6 # Speed on the way up
drop-velocity: 0.5 # Speed on the way down
pause: 20 # Ticks held at the top before dropping
settle: 20 # Ticks held on the ground before finishing
decoy-count: 8 # Extra items thrown out of the crate
decoy-spread: 0.25 # Horizontal spread of the thrown items. With several rewards, the landings are this far apart, at least 1.25 blocks
timeout: 400 # Safety cap in ticks; ends the roll if the item never settles
hide-placed-crate: false
quick:
height: 1.5 # Height the item rises to
rise-velocity: 0.05 # Upward speed
suspend: 10 # Ticks the item is held before finishing
hide-placed-crate: false
semi_instant:
velocity: # Initial throw velocity of the item
randomness: 0.2 # Random spread added to the velocity
x: 0
y: 0.3
z: 0
item-lifespan: 30 # Ticks the item exists before finishing
hide-placed-crate: false
slot_machine:
filler: black_stained_glass_pane name:"" # Item filling non-selected slots
selector: yellow_stained_glass_pane name:"" # Item marking the selected row
symbols: 18 # Symbols on the reel
spin-ticks: 36 # Ticks the reel spins
reel-stop-delay: 8 # Ticks between each reel stopping
spin-interval: 2 # Ticks between reel steps
start-pitch: 0.9 # Pitch of the first spin sound
pitch-step: 0.08 # Pitch increase per spin sound
hold-ticks: 30 # Ticks the won reward is held on screen after the last reel stops
Multiple rewards
Two sections of config.yml cover crates and pouches that give more than one reward per open, set up with bonus-chances as described in How to Make a Crate.
multi-reward
The server-wide defaults. A crate or pouch can override any of them, key by key, in its own multi-reward section, and keys it leaves out come from here. Missing keys use the defaults shown above.
| Key | Default | What it does |
|---|---|---|
fallback | sequential | How rolls with no multi-reward animation, such as rolls from other plugins, show several rewards. sequential plays the roll once per reward, each with its own reroll offer. primary plays the roll for the first reward and gives the bonus rewards straight after, with no animation or reroll for the bonus rewards. The first reward still gets its reroll offer. |
bonus-rerollable | true | If bonus rewards can be rerolled at all. The first reward follows the crate's normal reroll rules. Ignored for pouches, which never offer rerolls. |
bonus-chance-mode | overall | How bonus-chances combine into a number of bonus rewards: overall, chained or independent. |
reroll.multi
The menu shown after an animation that shows several rewards at once. It lists every reward from the open. Clicking a reward rerolls only that one, and accepting or closing the menu gives every reward. It is laid out like the normal reroll GUI, and the accept button can use locations the same way.
| Key | What it does |
|---|---|
title | The GUI title. |
rows | Rows in the menu. |
mask | The decorative filler items and pattern. |
rewards | A list of row and column slots the rewards show in, in order. Rewards beyond the last slot are not shown, so they can't be rerolled, but they are still given. |
accept | The button that keeps every reward. |
reroll-lore | Lines added to the lore of each reward that can be rerolled. %price% shows the cost of its next reroll. Rewards that can't be rerolled show without these lines. |
If no reward from the open can be rerolled, the menu doesn't open.
Where to go next
Rolls: see each animation in action on Animations / Rolls.
Multipliers: set up rank chance multipliers in Commands and Permissions.
Defaults: browse the shipped config here.