-
Notifications
You must be signed in to change notification settings - Fork 0
Dependencies
ClickerEconomy has one required dependency and several optional ones. This page explains what each dependency does, why it's needed, and how to set it up.
ClickerEconomy uses Vault as the bridge between the plugin and your server's economy. Every click reward is deposited through Vault's economy API.
- Why it's required: Without Vault, the plugin cannot deposit currency. The clicker GUI will refuse to open and players will see a "Economy is not available" message.
- Download: SpigotMC
Important: Vault alone is not enough. Vault is an API — it needs an economy provider plugin to actually manage player balances. You need both Vault and one of the economy plugins listed below.
You need at least one plugin that registers an economy implementation with Vault. Any of the following will work:
| Plugin | Notes |
|---|---|
| EssentialsX | Most common choice. Includes EssentialsX Economy out of the box. |
| CMI | All-in-one server management plugin with a built-in economy. |
| TheNewEconomy | Dedicated multi-currency economy plugin. |
| iConomy | Lightweight legacy economy plugin. |
If you already have an economy plugin running on your server, you're good to go — no extra setup needed.
PlaceholderAPI allows you to use %clicker_*% placeholders in other plugins such as scoreboards, tab lists, holograms, NPCs, and more.
- Download: SpigotMC
-
What happens without it: The plugin works perfectly fine. You just won't be able to use ClickerEconomy placeholders outside of
lang.yml. All internal%clicker_*%tokens inlang.ymlstill work regardless. When PlaceholderAPI is detected, the following placeholders are automatically registered:
| Placeholder | Description |
|---|---|
%clicker_clicks% |
Total lifetime clicks |
%clicker_rank% |
Rank by click count |
%clicker_balance% |
Vault economy balance |
%clicker_multiplier% |
Effective multiplier (personal × global) |
%clicker_personal_multiplier% |
Personal permission-based multiplier |
%clicker_global_multiplier% |
Server-wide global multiplier |
%clicker_multiplier_remaining% |
Seconds left on timed multiplier (-1 if permanent) |
%clicker_multiplier_remaining_fmt% |
Human-readable time remaining (e.g. "1h 30m 5s") |
You can also use any PlaceholderAPI placeholder (e.g. %player_name%, %server_online%) inside lang.yml item names, lore, and messages. They will be resolved automatically.
By default, ClickerEconomy stores all data in a flat data.yml file — no extra setup required. If you want to use a SQL database instead, you may need an additional JDBC driver depending on your chosen backend.
| Backend | Driver Required? | Notes |
|---|---|---|
| YAML | No | Default. Works out of the box. |
| H2 | No | Embedded file-based database. Bundled with the plugin, no external server needed. |
| MySQL | No | Most Minecraft hosting providers include MySQL. The driver (com.mysql.cj.jdbc.Driver) ships with the server. |
| MariaDB | Yes | Requires the MariaDB Java Connector on the classpath. |
| PostgreSQL | Yes | Requires the PostgreSQL JDBC Driver on the classpath. |
To switch backends, change storage.backend in config.yml and fill in your connection details under storage.sql. See the Configuration wiki page for the full reference.
| Dependency | Required? | Purpose |
|---|---|---|
| Vault | Yes | Economy API bridge |
| Economy provider (e.g. EssentialsX) | Yes | Handles actual player balances |
| PlaceholderAPI | No | Use %clicker_*% in external plugins |
| MariaDB JDBC Driver | Only if using MariaDB | Database connectivity |
| PostgreSQL JDBC Driver | Only if using PostgreSQL | Database connectivity |