Main Configuration

On this page, you will find everything you need to know about the config.yml options of Phoenix Currencies

Changes made by hand in config.yml apply with /pcur reload, except the Database settings, which need a restart. Options changed from the editor are saved straight away.

#General Configuration

Internal Pool Size - The number of threads the plugin keeps for its own background work. The default of 4 suits almost every server.
Debug - Adds verbose logging to the console, useful when reporting an issue.

performance:
  internal-pool-size: 4
debug: false

#Database

Balances, the player list, the transaction log, banks, banknotes, boosters and the daily counters are stored in the database. The available types are sqlite, mysql and mariadb. Servers that should share balances point at the same MySQL or MariaDB database, see Can several servers share the same balances?

Option	Description
table-prefix	Put in front of every table name, so several plugins or setups can share one database.
pool-size	The most connections the plugin keeps open at once.
jdbc-url-options	Extra options added to the connection URL, such as `useSSL=false`. Empty for none.

database:
  type: sqlite
  address: localhost
  name: phoenixcurrencies
  port: 3306
  username: root
  password: password
  table-prefix: pcur
  pool-size: 10
  jdbc-url-options: ''

#Vault

Which currency other plugins use, and how strongly. See Vault.

vault:
  enabled: true
  currency: money
  priority: Low

#Leaderboard

How often the leaderboards refresh, in seconds and 30 at the least, how many players each keeps, and how many one page of the top command shows. See Leaderboards.

leaderboard:
  refresh-seconds: 300
  size: 100
  page-size: 10

#Transactions

See Transaction Log.

transactions:
  enabled: true
  keep-days: 30

#Offline Players

The offline income notice, the cache of offline balances for placeholders, and the first-start import of known players. See Offline Players.

offline-income:
  enabled: true
  delay-ticks: 60
offline-cache-seconds: 30
import-known-players: true

#Other Settings

Option	See
server-name	Worlds and Servers
wallet	Wallet
afk	Interest and Rewards
history	Balance History
discord	Discord Webhook
redis	Redis Sync

#Currencies

There is no list of currencies in this file. Each currency is its own file, see Currency File.

#Messages & Translations

Every message the plugin sends lives in the translation file rather than in config.yml. See Languages & Translations.

Last updated about 2 hours ago