Installation

This page covers installing JConomy on a Spigot or Paper server from scratch.

If you have not already read Before You Begin, do that first. It describes what JConomy does and does not do, and what other providers must or must not be present on your server before you install.


Requirements

Requirement Version
Spigot or Paper 1.21 or later
Java 21 or later
VaultUnlocked Required

VaultUnlocked replaces Vault. If you currently have Vault installed, remove it and install VaultUnlocked instead. VaultUnlocked is a drop-in replacement: it provides all of the original Vault API at the same class locations, so every plugin that worked with Vault will continue to work with VaultUnlocked installed. You do not need both.


Download

Download the latest JConomy.jar from the JConomy GitHub project page.


Steps

  1. Install VaultUnlocked into your plugins/ folder. If you currently have Vault installed, remove it first — VaultUnlocked replaces it entirely.

  2. Remove any conflicting VaultUnlocked economy provider. Only one VaultUnlocked economy provider can be active at a time. If you have another plugin registered as the VaultUnlocked provider, remove it before continuing. See Before You Begin for details.

  3. Drop JConomy.jar into your server’s plugins/ folder.

  4. Start the server. JConomy will generate its configuration files and database on first startup.

  5. Confirm JConomy loaded. Check the server console for a message from JConomy. If VaultUnlocked is missing, JConomy will log a message and disable itself — check that VaultUnlocked loaded successfully first.

  6. Stop the server and configure JConomy before going live. At minimum, define your currencies in plugins/JConomy/config.yml.

  7. Restart the server to apply your configuration.


Files generated on first startup

On first startup, JConomy creates the following files and directories:

plugins/
  JConomy/
    config.yml       ← default configuration file
    jconomy.db       ← SQLite database (created automatically)
    modules/         ← directory for expansion JARs (empty by default)

You do not need to create any of these manually. If config.yml is absent when the server starts, JConomy will generate it with defaults.


Next steps

Once JConomy is running, proceed to Configuration to define your currencies and adjust settings for your server.


This site uses Just the Docs, a documentation theme for Jekyll.