Configuration

There are several configuration sections, some of which have several subsections.

backend

The data storage backend we're using.

JSON requires little to no configuration, is transferable between different machines, but is slow.

MySQL requires (obviously) a MySQL database, but performs much better and is easy to move to another server/machine.

Subsections

• type - The backend type. Can be 'json' or 'mysql'
• file - If we're using JSON, this is a relative path (to the plugin's data folder) where the database is stored.
• host - If we're using MySQL, this is the database host.
• port - If we're using MySQL, this is the database port. Default is 3306.
• database - If we're using MySQL, this is the database name.
• username - If we're using MySQL, this is the database username.
• password - If we're using MySQL, this is the database password.
• table_prefix - If we're using MySQL, the names of all database tables will be prefixed with this string.
• useSsl - If we're using MySQL, whether to use SSL or not. Default is false.

old-backend

This is the same as backend, except if this is defined, data will be converted from the backend defined here to the backend defined in the backend section.

This section is automatically deleted after conversion takes place, so that conversion is only performed once.

currency

Information about the virtual currency we're using.

Subsections

• name - Information about the currency's name.

  Subsections:

  • singular - Singular form of the name. Example: "dollar"
  • plural - Plural form of the name. Example: "dollars"

• format - Format of displayed amounts in the currency. The default is fine. For advanced users, see here.

• grouping - Grouping of displayed amounts in the currency. Default is 0, so amounts will look like 1000000. If you want a reasonable value, try 3. This will make amounts look like 1,000,000.

• balance-format - How the balance is displayed. Default is {amount} {currency name}, but if you want to change it to something like ${amount}, you would set this to ${1}.

chat

Information about chat messages sent by the plugin.

Subsections

• prefix - String that all chat messages from the plugin to players will be prefixed with. & is supported for color codes.

economy

Information about the server's economy.

Subsections

• start-balance - If this is present and greater than 0, this amount will be given to new players upon their first join.
• notify-start-balance - If this is present and false, players will not be sent a message upon receiving their starting balance.
• server-account - If this is present, the account with this name will appear to have an infinite balance to anything using the API. Use with caution, and do not set this to the name of a player.

locale-override

There are no subsections for this value. Set it to true to override Java's locale to English. This may break other plugins or cause weird behaviour, but should fix balances > 1000 rolling over to 0.

debug

There are no subsections for this value. Set it to true to enable debugging. This consists of more verbose logging and automatic restoring of the default config on every plugin reload.

log-transactions

If true, transactions will be logged to the database specified in logger-database.

logger-database

Database to log transactions to. Same subsections as MySQL database at the top of this page. Uses a different table name than the main data, so the same MySQL database can be used.

multi-server-sync

Experimental multiserver sync support. Set this to true, and it will probably cause balance updates to immediately show up across your BungeeCord network.