Skip to content

Installation

Jump to bottom
snazzyatoms edited this page Apr 9, 2026 · 3 revisions

Installation

This page explains how to install Coffers on your server and choose the correct jar for your setup.

Choose the Correct Jar

Coffers currently ships in three different artifacts:

  • Coffers.jar The modern server jar for the main Coffers line

  • Coffers-Legacy.jar The legacy server jar for older Spigot, Paper, and Purpur-style server setups

  • Coffers-API.jar An optional developer jar intended for plugin developers, not normal server owners

Which One Should I Use?

Use the jar that matches your server:

  • Use Coffers.jar if you are running the modern Coffers line on Paper 1.21.x
  • Use Coffers-Legacy.jar if you are running an older server environment and need the legacy Coffers line
  • Do not install Coffers-API.jar as a normal economy plugin on your server

Basic Installation Steps

  1. Download the correct jar for your server.
  2. Stop the server if it is currently running.
  3. Place the jar into your server plugins folder.
  4. Start the server once so Coffers can generate its default files.
  5. Open the generated configuration file and review the storage settings.
  6. Restart the server after making configuration changes.

First Startup

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, or disabled
  • review the default currency definitions

Storage Setup

Coffers supports multiple storage backends:

  • yaml
  • sqlite
  • mysql

Recommended usage:

  • use yaml for simple and lightweight servers
  • use sqlite for persistent single-server storage
  • use mysql for larger or shared deployments

The modern line and the legacy line each have their own configuration files and storage paths.

Vault Compatibility

Coffers includes built-in Vault compatibility.

This means you do not need a separate Vault bridge plugin for Coffers itself.

Available modes:

  • auto Register with Vault only when Vault is installed

  • enabled Force Coffers to expose a Vault economy provider when Vault is present

  • disabled Never register the Vault bridge

Commands After Installation

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]

Common Mistakes

Avoid these common setup problems:

  • installing Coffers-API.jar instead 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.x setup 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

Next Step

After installation, continue to:

Clone this wiki locally