🗂️ 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/PhoenixShop.

plugins/PhoenixShop/
├── shops/
│   ├── shop.yml
│   └── shop/
│       ├── blocks.yml
│       └── valuables.yml
├── menus/
├── translations/
├── addons/
├── exports/
├── backups/
├── layout-sessions/
├── config.yml
├── settings.yml
├── database.db
├── discord.yml
└── pricing.yml

#Folders

Folder	Contents
shops	One file per shop, plus a folder of the same name holding one file per category. See Shop Configuration File.
menus	The menu layouts, one folder per shop. See Customize Menus.
translations	The language file. See Languages & Translations.
addons	Add-on jars, and a folder per add-on with its own settings. Drop a new add-on here and restart.
admin_signs ⭐	One file per server-owned sign shop.
exports ⭐	Purchase history exported with `/pshop history export`.
backups	A copy of a file taken before the plugin rewrote it. See the note below.
layout-sessions	The inventory of an admin editing a menu layout, kept so it is given back after a crash. Never edit this by hand.

#Files

File	Contents
config.yml	The main settings and the database connection. See Main Configuration.
database.db	The SQLite database, when SQLite is used. It also holds every player shop, sign shop, NPC shop and shop stand.
settings.yml	Transactions, menus, locked categories, the IP limit and sign shops. See Settings File.
discord.yml ⭐	The Discord webhooks.
pricing.yml ⭐	The last 10 price generator runs, so they can be undone.

When a file is missing settings, the plugin rewrites it and keeps what you had in backups, under the same path. A shop or category file that is not valid YAML is never rewritten: it is skipped, reported in the console, and left exactly as it is until you fix it and run /pshop reload.

#What Lives in the Database

Transactions, remaining stock, per-player purchase limits and restock timers are not in these files, and neither are restock alert choices ⭐. They are stored in the database configured in config.yml, which is SQLite (database.db) by default and MySQL or MariaDB ⭐ if you set it up.

#Moving to Another Server

To carry your setup across:

Configuration - copy shops/, menus/, translations/, config.yml, settings.yml and the add-on folders inside addons/.
Sign and chest shops - sign shops, NPC shops, shop stands and player shops are in the database, so they come across with it, but only if the worlds come across too.
Transactions and stock - point the new server at the same MySQL database, or copy database.db across.

#What to Back Up

The whole plugins/PhoenixShop folder, plus your database if you use MySQL or MariaDB. 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, which is useful to attach when you report an issue to us.

Last updated about 1 hour ago