-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
- Paper, Purpur, or Folia
- Minecraft 1.19.x through 1.21.x (see Platform Support for the current tested range)
- Java 21 or newer
Exchequer does not support Spigot or CraftBukkit. This is a hard limitation, not a choice: if you run Exchequer alongside Towny, note that Towny itself dropped Spigot and CraftBukkit support as of version 0.102.0.0, so this restriction exists upstream regardless of Exchequer's own code.
Exchequer runs standalone with neither of these installed. Both are soft dependencies that unlock additional functionality when present.
| Plugin | What it unlocks |
|---|---|
| Towny | Nation and town level treasuries, GDP tracking per nation, taxation governance, trade routes, sanctions |
| Vault | The Economy API bridge (so shops, jobs plugins, and other Vault dependent plugins can read/write balances), and MONEY as a tradeable currency inside the exchange system |
Without Towny, every player has their own personal treasury and GDP instead of a nation wide one. Without Vault, there is no MONEY currency and no Economy API bridge for other plugins to hook into.
- Download the correct build for your license tier (single server or network) from your BuiltByBit purchase, or SpigotMC if you purchased there.
- Drop the jar into your server's
pluginsfolder. - Start or restart the server. Exchequer generates a default
config.ymlon first run. - Stop the server and review
config.ymlbefore continuing, especially the tracked materials list and the tax cycle settings. Defaults are reasonable but not tuned to your specific server's economy. - Start the server again. Run
/exchequer bankas an operator to confirm the plugin loaded correctly and the Bank GUI opens.
If you have Towny and/or Vault installed, run /exchequer status (or check the console log on startup) to confirm both are detected. The startup log will state clearly whether each soft dependency was found.
If you purchased the network license, see Cross Server Setup for the MySQL and Redis configuration required to sync balances and rates across multiple backend servers. A network license jar will not sync automatically without this configuration.
Always read the changelog before updating a live server. Some updates, particularly ones that touch the material registry or AMM pool structure, may require a one time data migration. This will be called out explicitly in the changelog when it applies. Back up your database file (or your MySQL Exchequer tables, for network setups) before any major version update.
# Installation- Paper, Purpur, or Folia
- Minecraft 1.19.x through 1.21.x (see [Platform Support](Platform-Support.md) for the current tested range)
- Java 21 or newer
Exchequer does not support Spigot or CraftBukkit. This is a hard limitation, not a choice: if you run Exchequer alongside Towny, note that Towny itself dropped Spigot and CraftBukkit support as of version 0.102.0.0, so this restriction exists upstream regardless of Exchequer's own code.
Exchequer runs standalone with neither of these installed. Both are soft dependencies that unlock additional functionality when present.
| Plugin | What it unlocks |
|---|---|
| Towny | Nation and town level treasuries, GDP tracking per nation, taxation governance, trade routes, sanctions |
| Vault | The Economy API bridge (so shops, jobs plugins, and other Vault dependent plugins can read/write balances), and MONEY as a tradeable currency inside the exchange system |
Without Towny, every player has their own personal treasury and GDP instead of a nation wide one. Without Vault, there is no MONEY currency and no Economy API bridge for other plugins to hook into.
- Download the correct build for your license tier (single server or network) from your BuiltByBit purchase, or SpigotMC if you purchased there.
- Drop the jar into your server's
pluginsfolder. - Start or restart the server. Exchequer generates a default
config.ymlon first run. - Stop the server and review
config.ymlbefore continuing, especially the tracked materials list and the tax cycle settings. Defaults are reasonable but not tuned to your specific server's economy. - Start the server again. Run
/exchequer bankas an operator to confirm the plugin loaded correctly and the Bank GUI opens.
If you have Towny and/or Vault installed, run /exchequer status (or check the console log on startup) to confirm both are detected. The startup log will state clearly whether each soft dependency was found.
If you purchased the network license, see [Cross Server Setup](Cross-Server-Setup.md) for the MySQL and Redis configuration required to sync balances and rates across multiple backend servers. A network license jar will not sync automatically without this configuration.
Always read the changelog before updating a live server. Some updates, particularly ones that touch the material registry or AMM pool structure, may require a one time data migration. This will be called out explicitly in the changelog when it applies. Back up your database file (or your MySQL Exchequer tables, for network setups) before any major version update.