📁 Main Configuration

#General Configuration

Below is a list of options that are in the config.yml and a description of what they do.

• Knockback - This option allows you to change the knockback that the player takes when trying to open a crate with the wrong key
• Quick-Open - This option will enable players to quick open when holding the crate key and shifting right-clicking it.
• Render-Radius - This option allows you to define the distance that effects will need to stop showing to the player.
• Disable Confirmation Menus - This option allows you to skip confirmation menus (open money cost, selective reward mode) so players go straight to the action.
• Key Mainhand Requirement - This option allows you to define whether players will need to have a key in their main hand to open crates. Enabled by default.

All of these options can also be changed in-game from the editor's Settings menu.

The following ones exist only in the file:

• Hologram Refresh Rate - How many ticks pass between two refreshes of the built-in crate holograms. A higher value updates placeholders in the hologram less often and costs less. Values below 10 are raised to 10.
• Internal Pool Size - performance.internal-pool-size, the number of threads the plugin uses for its own background work such as database reads and animation preparation. The default of 5 suits almost every server. Raise it only if you run a very large network and see the plugin queueing work.
• Notify If New Version - Whether players with the admin permission are told on join that a newer version of the plugin is out.
• Join Reminder - Lite only, sends the players a message on join about the premium version.
• Debug - Adds verbose logging to the console, useful when reporting an issue.
• Product License - Premium only, your license key. See Licensing.

#Broadcast Message (Lite)

The Lite version has a single broadcast message shared by every crate, set in config.yml. The Premium version does not use this option, because there the broadcast message is configured per crate from the editor.

crates:
  broadcast-message:
  - '&ePlayer &a%player% &ejust got &6"%reward%" &ereward from the crate &6%crate%&e!'

#Commands

The virtual keys and the pay key commands can each be turned off, and given an alternative name that is registered next to the default one, which is useful when another plugin already claims the same command.

Pay key is disabled by default, so /crates payKey only exists after enabling it here.

commands:
  virtual-keys:
    enabled: true
    alternative: virtualkeys
  pay-key:
    enabled: false
    alternative: paykey

#Database

The plugin also supports databases. The available options are mysql and sqlite.

database:
  type: sqlite
  address: localhost
  name: phoenixcrates_db
  port: 3306
  username: phoenixuser
  password: phoenixpassword
  table-prefix: pc

#Connection Pool

When using MySQL, the connection pool can be tuned under database.hikari. The defaults are good for a normal server, and are worth revisiting only if you run a large network or your database is on a different machine.

database:
  hikari:
    maximumPoolSize: 10
    minimumIdle: 5
    idleTimeout: 300000
    maxLifetime: 1700000
    connectionTimeout: 30000
    fetch-timeout: 5000

Option	Description
maximumPoolSize	The most connections the plugin will open at once.
minimumIdle	How many connections are kept open while idle.
idleTimeout	How long, in milliseconds, an idle connection is kept before being closed.
maxLifetime	How long, in milliseconds, a connection lives before being replaced. Keep it under your MySQL wait_timeout.
connectionTimeout	How long, in milliseconds, to wait for a free connection before giving up.
fetch-timeout	How long, in milliseconds, to wait for a player's data before treating it as unavailable.

Save the file and reload the plugin to apply the changes.

#Messages & Translations

Every message the plugin sends lives in the translation file rather than in config.yml, and language decides which one is loaded. Editing the wording, silencing a message, and running the plugin in another language are all on Languages & Translations.

#MiniMessage

On top of the usual & colour codes, text accepts MiniMessage tags for gradients, hover text and clickable links. It has its own page: Rich Text (MiniMessage).