🗂️ File Structure

On this page, you will find what every file and folder in the plugin's folder is for, what to back up, and what to copy when moving to another server.

#Overview

Everything the plugin writes lives in plugins/PhoenixCrates.

plugins/PhoenixCrates/
├── addons/
├── crates/
├── keys/
├── menus/
├── translations/
├── internal/
├── logs/
├── config.yml
├── locations.yml
├── templates.yml
├── internal_storage.yml
├── messages.yml
└── rarities.yml

#Folders

Folder	Contents
crates	One file per crate. See Crate Configuration File.
keys	One file per key.
menus	The menu layouts. See Customize Menus.
addons	Add-on jars. Drop a new add-on here and restart.
translations	The language files. The active one is picked with `language` in `config.yml`.
internal	Plugin-managed working data. Never edit this by hand.
logs	Written by the logger. See Log the Actions.

#Files

File	Contents
config.yml	The main settings, the database connection and the license. See Main Configuration.
locations.yml	Every crate placed in the world, with its coordinates and facing. See the note below.
templates.yml	The hologram style shared by every crate.
internal_storage.yml	Items saved from the editor that are not tied to a single crate.
messages.yml	Legacy message file, kept for configurations made before translations were introduced.
rarities.yml	The rarities, when the Rarity add-on is installed.

Installed add-ons add one file each: crate-claim.yml, mass-opening.yml, ip-limit.yml, reward-on-loop.yml, redis.yml, and logger.yml for the logger.

locations.yml is what makes a placed crate exist. Deleting it leaves every crate configured but no longer placed anywhere in the world.

#What Lives in the Database

Player progress is not in these files. Virtual keys, open cooldowns, opened counts, win limits and rerolls are all stored in the database configured in config.yml, which is SQLite (a file inside the plugin folder) by default and MySQL if you set it up.

#Moving to Another Server

To carry your setup across:

Configuration - copy crates/, keys/, menus/, translations/, config.yml, templates.yml, internal_storage.yml, rarities.yml and the add-on files.
Placed crates - copy locations.yml, but only if the worlds come across too. A location pointing at a world that does not exist is skipped.
Player progress - point the new server at the same MySQL database, or copy the SQLite file across.

If you copy config.yml to a second server, remember that a license only allows a limited number of concurrent sessions. See Licensing.

#What to Back Up

The whole plugins/PhoenixCrates folder, plus your database if you use MySQL. The editor writes changes to these files as you make them, so a backup taken while the server runs is a valid one.

#Reporting a Problem

Turning on debug in config.yml adds verbose console logging and creates a debug_output folder with extra diagnostics. Both are useful to attach when you report an issue to us.

Last updated about 2 hours ago