-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
This page explains how to install Coffers on your server and choose the correct jar for your setup.
Coffers currently ships in three different artifacts:
-
Coffers.jarThe modern server jar for the main Coffers line -
Coffers-Legacy.jarThe legacy server jar for older Spigot, Paper, and Purpur-style server setups -
Coffers-API.jarAn optional developer jar intended for plugin developers, not normal server owners
Use the jar that matches your server:
- Use
Coffers.jarif you are running the modern Coffers line on Paper1.21.x - Use
Coffers-Legacy.jarif you are running an older server environment and need the legacy Coffers line - Do not install
Coffers-API.jaras a normal economy plugin on your server
- Download the correct jar for your server.
- Stop the server if it is currently running.
- Place the jar into your server
pluginsfolder. - Start the server once so Coffers can generate its default files.
- Open the generated configuration file and review the storage settings.
- Restart the server after making configuration changes.
On first startup, Coffers will create its plugin data folder and default configuration files.
After that first boot, you should:
- review the configured storage backend
- confirm whether Vault compatibility should be
auto,enabled, ordisabled - review the default currency definitions
Coffers supports multiple storage backends:
yamlsqlitemysql
Recommended usage:
- use
yamlfor simple and lightweight servers - use
sqlitefor persistent single-server storage - use
mysqlfor larger or shared deployments
The modern line and the legacy line each have their own configuration files and storage paths.
Coffers includes built-in Vault compatibility.
This means you do not need a separate Vault bridge plugin for Coffers itself.
Available modes:
-
autoRegister with Vault only when Vault is installed -
enabledForce Coffers to expose a Vault economy provider when Vault is present -
disabledNever register the Vault bridge
Once Coffers is installed and the server has started successfully, you can begin using commands.
Modern line:
/coffers balance [player] [currency]/coffers pay <player> <amount> [currency]/coffers set <player> <amount> [currency]/coffers history [player] [limit]/coffers currencies/coffers migratevault [provider]
Legacy line:
/cofferslegacy balance [player] [currency]/cofferslegacy pay <player> <amount> [currency]/cofferslegacy set <player> <amount> [currency]/cofferslegacy history [player] [limit]/cofferslegacy currencies/cofferslegacy migratevault [provider]
Avoid these common setup problems:
- installing
Coffers-API.jarinstead of the real server plugin jar - using the modern jar on a legacy server environment
- using the legacy jar on a modern Paper
1.21.xsetup when you intended to use the main line - forgetting to restart after changing storage settings
- assuming Vault compatibility works when Vault is not installed and the mode is not configured appropriately