Skip to content

Installation

Jump to bottom
Richie Lee edited this page Jun 2, 2026 · 1 revision

Installation

This page walks you through setting up ClickerEconomy from scratch. The plugin works out of the box with minimal setup — most servers will be up and running in under a minute.

Requirements

Requirement Details
Server software Spigot, Paper, or any Spigot fork. CraftBukkit is not supported.
Minecraft version 1.16 or newer
Java version Java 17 or newer
Vault Required — provides the economy API bridge
Economy provider Required — any Vault-compatible economy plugin (see below)

Step 1 — Install Vault

If you don't already have Vault installed:

  1. Download Vault from SpigotMC.
  2. Drop the Vault.jar into your server's plugins/ folder. Vault is just an API layer — it doesn't handle money on its own. You need an economy provider alongside it.

Step 2 — Install an Economy Provider

You need at least one plugin that provides an economy implementation to Vault. If you already run one of these, skip this step.

Plugin Notes
EssentialsX Most popular choice. Economy is included by default.
CMI All-in-one management plugin with built-in economy.
TheNewEconomy Dedicated multi-currency economy plugin.

Any other plugin that registers an economy with Vault will also work.

Step 3 — Install ClickerEconomy

  1. Download ClickerEconomy.jar.
  2. Drop it into your server's plugins/ folder.
  3. Start or restart the server. On first boot the plugin will generate three files in plugins/ClickerEconomy/:
File Purpose
config.yml All behaviour settings (rewards, cooldowns, storage, sounds, GUI layout)
lang.yml All player-facing text (messages, item names, lore, GUI title)
data.yml Click counts and multiplier state (when using YAML storage)

That's it. Players can now run /clicker to open the GUI and start clicking.

Step 4 — Verify It Works

  1. Join the server.
  2. Run /clicker — the clicker GUI should open.
  3. Click the clicker item — you should receive currency and hear the reward sound.
  4. Run /clicker stats — you should see your click count, balance, and multiplier. If the GUI doesn't open or you see an "Economy is not available" message, double-check that both Vault and your economy provider are installed and loaded. Run /plugins to confirm all three plugins show green.

Optional — Install PlaceholderAPI

PlaceholderAPI lets you use %clicker_*% placeholders in other plugins like scoreboards, tab lists, and holograms.

  1. Download PlaceholderAPI from SpigotMC.
  2. Drop it into plugins/ and restart the server.
  3. ClickerEconomy detects it automatically — no extra configuration needed. You'll see this message in console when it's working:
[ClickerEconomy] PlaceholderAPI found — placeholders registered.

See the Placeholders wiki page for the full list of available tokens.

Optional — Switch to Database Storage

By default all data is stored in data.yml. For larger servers, you can switch to a SQL database for better performance.

H2 (Embedded)

No external server needed — just change one line:

storage:
  backend: h2

Restart or run /clicker reload. The plugin creates an H2 database file in the plugin folder automatically.

MySQL

storage:
  backend: mysql
  sql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: "your_password"

Make sure the database exists before starting the plugin. The plugin will create its tables (ce_clicks, ce_multiplier) automatically.

MariaDB / PostgreSQL

Same as MySQL, but change backend to mariadb or postgresql and adjust the port if needed. These require their respective JDBC drivers on the classpath. See the Dependency wiki page for details.

See the Configuration wiki page for the full list of storage options including connection pool tuning.

File Structure

After a successful setup, your plugin folder should look like this:

plugins/
└── ClickerEconomy/
    ├── config.yml        — Behaviour settings
    ├── lang.yml          — All player-facing text
    └── data.yml          — Click data and multiplier state (YAML backend only)

When using H2 storage, you'll also see h2data.mv.db in the same folder.

Updating

To update ClickerEconomy:

  1. Replace the old .jar with the new one in plugins/.
  2. Restart the server (or run /clicker reload for config-only changes). The plugin handles config migration automatically. Any new keys are added to your existing config.yml and lang.yml, and a backup of the old files is saved as config_v<old>.bak and lang_v<old>.bak before any changes are made. You never need to delete your config files or merge them manually.

Troubleshooting

Problem Solution
"Economy is not available" when opening GUI Vault or your economy provider isn't installed or didn't load. Check /plugins.
Plugin doesn't generate config files Make sure you're running Spigot/Paper, not CraftBukkit.
Sounds not playing or invalid sound errors in console Sound enum names differ between Minecraft versions. Check the Bukkit Sound javadocs for your version.
Custom skull texture not loading Verify the base64 string is correct and that material is set to PLAYER_HEAD. Check console for warnings.
Database connection failed Verify your host, port, credentials, and that the database exists. Check that the JDBC driver is available for MariaDB/PostgreSQL.
Config looks wrong after updating The plugin backs up your old config before migrating. Check for config_v<old>.bak in the plugin folder if you need to compare.

Clone this wiki locally