Skip to main content

Config.yml

The config.yml allows you to modify global settings for the plugin.

Prefix

Change the prefix shown before a message from the plugin.

prefix: '&8[&bCrates&8]&e'

Locale

Change the language of the plugin. The following languages are supported:

LanguageCode
Englishen
Frenchfr
Italianit
Chinesezhs
Russianrf
Germande
Vietnamesevn
Spanishes
Turkishtr
locale: en

Logger

Enable a built in logger used as a debugging tool to see events occuring.

logger: false

Decimal Format

Change how the plugin should handle decimal numbers. Eg #.## results in 1.23, and #.# results in 1.2.

decimal-format: '#'

Cooldown

How long a player has to wait between actions.

cooldown: 1.0

Hologram Provider

Change what plugin is used for holograms. Supported plugins are CMI and HolographicDisplays. CrateReloaded Pro also supports DecentHolograms

hologram-plugin: 'HolographicDisplays'

Creative Settings

This setting is used to prevent duplication of keys while in creative mode.

creative:
# Enables safety checks
safety: true
# Allows ops to override the safety checks imposed on creative players
exclude-ops: false

Timezone

Change the timezone the plugin uses. Common timezones:

TimezoneAbbreviationTime Offset
Greenwich Mean TimeGMTUTC +0
Eastern Standard TimeESTUTC -5
Central Standard TimeCSTUTC -6
Mountain Standard TimeMSTUTC -7
Pacific Standard TimePSTUTC -8
Central European Standard TimeCESTUTC +2

See the full list of timezones here.

timezone: 'PST'

Date Format

Change the formatting the plugin uses for date and time. Most common formatting:

LetterFunctionResult
yyYear (short)23
yyyyYear (long)2023
MMMonth (number)12
MMMMonth (shortened)Dec
MMMMMonth (long)December
dDay of the month (no leading 0)9
ddDay of the month (leading 0)09
EDay name (short)Tue
EEDay name (long)Tuesday
aAM or PMAM
HHour in day (0-23)23
kHour in day (1-24)24
KHour in 12 hour format (0-11)0
hHour in 12 hour format (1-12)12
mMinute in hour59
sSecond in minute32

See complete list here.

date-format: 'E, dd MMM yyyy HH:mm:ss z'

Claim Settings

All the settings for the /cr claim function.

Command

Change the base command that is used (/cr) Do NOT change this unless conflicting

command: 'cr'

Limit

Maximum amount of rewards a player can claim from /cr claim. Either this number, or the amount of free inventory slots the user has.

limit: 15

The name of the /cr claim menu.

menu: 'Claim Rewards!'

Handle Full Inventory

Should the claim manager handle it if the players inventory is full, if disabled, items will drop to the ground.

  handle-full-inventory: true

Reminder Settings

Configure the reminder function of pending rewards to claim.

Join

Should a reminder be given to the user when the join the server?

join: true

Timer

Should the player be reminded at set intervals of time?

timer: true

Period

If timer is true, how long is should the interval be?

period: 900

Format

How the items should look in the /cr claim menu.

Item

Change how the items description will look.

- '{lore}'
- '&7Number of Rewards: &6{number}'
- '&7Received on {date}'

Item Success

How the item should look once claimed.

item-success: '&a&lClaimed!'

Crate

Configure settings regarding crates.

Comparison Level

Change how much an item needs to match a crate to be valid.

0 - Name, type, and lore. 1 - (Setting 0), Enchants, and item flags 2 - (Setting 1), Custom NBT

compare: 0

Display

Add an item that is shown during an animation.

display: ''

Name of the preview menu.

menu: 'Menu'

Confirmation Menu

Name of the confirmation menu.

confirmation-menu: 'Confirm!'

Craft

Can players put crates/keys into crafting inventories?

craft: false

Item Frame

Can players put crates/keys into item frames?

item-frame: false

Peri Exit

Can players quit animations that havent fully completed?

peri-exit: false

CSGO

Length of the CSGO animation

csgo: 6

Roulette

Length of the roulette animation

roulette: 5

Wheel

Length of the wheel animation

wheel: 8

Buttons

Configure what buttons in the different GUIs will look like.

Enabled

Enable/disable buttons in GUIs.

enabled: true

Next

Go to the next page in a GUI.

next: 'ARROW 1 name:&aNext_Page lore:&eClick_to_enter_the_next_page.'

Close

Exit a GUI.

close: 'MUSIC_DISC_11 1 name:&4Close! flag:HIDE_POTION_EFFECTS'

Back

Go to the previous page in a GUI.

back: 'RED_BED 1 name:&4&lGo_back lore:&eGo_back_to_previous_page.'

Accept

The accept button in the confirmation menu of a crate.

accept: 'GREEN_STAINED_GLASS_PANE 1 name:&aYes lore:&fClick_here_to_open_{crate}!'

Decline

The decline button in the confirmation menu of a crate.

decline: 'RED_STAINED_GLASS_PANE 1 name:&4No'

CSGO Top

The item displayed above a winning item in the CSGO animation.

csgo-top: 'REDSTONE_TORCH 1 name:&6Prize!'

CSGO Bottom

The item displayed below a winning item in the CSGO animation.

csgo-bot: 'REDSTONE_TORCH 1 name:&6Prize!'

Pushback

Settings regarding pushback when a crate is clicked without a valid key.

Enabled

Should the user be pushed back?

enabled: true

Modifier

How far should the user be pushed back?

x: 1.0
y: 1.0
z: 1.0

Hologram

Settings for holograms.

Modifier

Offset for the holograms to be displayed, by default holograms are centered one block above the crate.

x: 0.0
y: 0.0
z: 0.0