HyperCurrencies is a simple customizable Spigot Plugin, adding currencies to your server. HyperCurrencies is built with a configurable currency system, allowing you to create your own currencies with starting, min & max balance! You can even synchronize your currency to Vault, store your data with MySQL and use our API to get players' balances in your code.


Setting up a currency
First, use /c create <name> to create your currency, providing a name for later use.

Next, let's customize the currency for our liking.
To do this, use the /c set <property> <value> <currency>. We can start by setting the starting balance for every new player joining the server.

Do this with /c set startingbal 300 testcurrency. Now new players will start with 300 balance.

If you want your player-base to be able to pay each other balance, use /c set pay true testcurrency.
Optional: use /c set paymin AMOUNT CURRENCY to set a minimum balance, so your players have to pay at least a specific amount of balance.

Synchronizing Vault and HyperCurrencies
Let's say you already use Vault on your server, and don't wanna switch to HyperCurrencies because of that. In this case, we got your back! Let me explain:

When you've created a currency (shown above), let's just call it 'Money', you can set the 'currency provider' to vault by using this simple command: /c set provider vault Money. Now all responsibility for the currency is on Vault, which also means that all other properties set (e.g. startingbal, minbal, maxbal) is not usable anymore.

Using MySQL
To use MySQL for storing currency data, you do almost the same as with Vault. First, set the provider to 'hc-sql', which is the built-in MySQL provider:
/c set provider hc-sql SQLCurrency
Next up you need to set the database URL, username and password (don't worry, we won't share it with anyone!) like this:
/c set sql:url DB_URL SQLCurrency
/c set sql:username DB_USERNAME SQLCurrency
/c set sql;password DB_PASSWORD SQLCurrency
And the you're all set!

Customizing Messages and changing language
HyperCurrencies supports custom messages and languages for all player commands. If you want to change the language to an already translated language, execute /hc setlang <language>. To check if the language is supported, head into HyperCurrencies' lang folder and check if there's a file with the name of your language and country (lang_<language in two characters>-<country in two characters>.yml. E.g. lang_en-us.yml). If you want to translate HyperCurrencies to a language, please join the discord.

Example for setting language to english: /hc setlang lang_en-us

If you want to customize the messages for your server, head into the lang folder, inside of HyperCurrencies' folder. In there, create a new file and call it whatever you want. Next, copy all the text from the spoiler below and paste it into your file. Your language file will now be exactly like the default file built into HyperCurrencies. You can freely customize all the messages, and when you're done, head into minecraft and execute the command /hc setlang FILE_NAME (replace file_name with the name of your file without file extension).

Click here to view the default lang file.

Version Support
HyperCurrencies support all versions from 1.8 and above.

Feature Requests and Bug reports
If you found a bug, or have an idea that could improve HyperCurrencies, please open an issue at the GitHub page.

Using HyperCurrencies in Java
We have a wiki (not up to date, instead use javadoc) including documentation for both hooking into HyperCurrencies in another currency plugin, and managing HyperCurrencies server-side.

Please do not leave a bad review because of a bug or a lack of features, please report/request it instead.