Main Configuration

plugins/Obfeco/config.yml holds storage, caching, formatting, integrations, logging and a few GUI settings. Apply edits with /obfeco reload, except storage-type and database, which need a restart.

Full default file

yaml

storage-type: SQLITE

database:
  host: localhost
  port: 3306
  database: obfeco
  username: obf
  password: test123
  pool-size: 10
  connection-timeout: 30000
  max-lifetime: 1800000

cache:
  batch-save-interval: 120
  auto-save-on-quit: true

formatting:
  thousands: k
  millions: M
  billions: B
  trillions: T
  quadrillions: Q
  decimal-places: 2

vault:
  enabled: true
  primary-currency: dollars

placeholder:
  enabled: true
  top-cache-minutes: 5

logging:
  console: false
  file: true
  admin-transactions: true
  user-transactions: true

gui:
  currency-manager:
    use-categories: false
    create-lore:
      - "Click to create a new"
      - "currency for your server."
    currency-lore:
      - "ID: {id}"
      - "Display: {display}"
      - "Starting: {starting}"
      - "Decimals: {decimals}"
      - ""
      - "Left-Click to edit"
      - "Right-Click to delete"

Storage

Key	Default	Description
`storage-type`	`SQLITE`	`SQLITE`, `MYSQL` or `YAML`. Restart to apply.
`database.*`	—	MySQL connection settings, only read when `storage-type: MYSQL`.

Every option is covered in Database Setup.

Cache

Key	Default	Description
`batch-save-interval`	`120`	Seconds between saves of changed balances to storage.
`auto-save-on-quit`	`true`	Save a player's changed balances as soon as they leave.

Balances live in memory while they're in use and are written in batches. See Performance Guide before changing these.

Formatting

Key	Default	Description
`thousands`	`k`	Suffix from 1,000
`millions`	`M`	Suffix from 1,000,000
`billions`	`B`	Suffix from 1,000,000,000
`trillions`	`T`	Suffix from 1,000,000,000,000
`quadrillions`	`Q`	Suffix from 1,000,000,000,000,000
`decimal-places`	`2`	Decimals shown for currencies with `use-decimals: true`, and for raw placeholders

These apply to every currency. Each currency's format and use-decimals decide the rest; see Currencies → Number formatting.

Vault

Key	Default	Description
`enabled`	`true`	Register Obfeco as the Vault economy when Vault is installed. Restart to apply.
`primary-currency`	`dollars`	Currency id Vault plugins use. Also the default for `/obfeco balance`.

See Vault.

PlaceholderAPI

Key	Default	Description
`enabled`	`true`	Register the `obfeco` expansion when PlaceholderAPI is installed. Restart to apply.
`top-cache-minutes`	`5`	How long leaderboard and total results are cached.

See PlaceholderAPI.

Logging

Key	Default	Description
`console`	`false`	Obfeco's info lines in the console. Warnings and errors always show.
`file`	`true`	Write transaction log files to `logs/`.
`admin-transactions`	`true`	Log `give`, `take`, `set`.
`user-transactions`	`true`	Log `pay`.

See Transaction Logging.

GUI

Key	Default	Description
`gui.currency-manager.use-categories`	`false`	Browse `/obfeco manage` by category. Needs at least one category in `categories.yml`.
`gui.currency-manager.create-lore`	—	Lore on the "Create New Currency" button.
`gui.currency-manager.currency-lore`	—	Lore on each currency. Supports `{id}`, `{display}`, `{starting}`, `{decimals}`, `{notify-give}`, `{notify-take}`.

The menu title and button names are in messages.yml; see Message Customization. Configs from older versions may still have cache.use-caffeine or title, create-button and close-button under gui.currency-manager; nothing reads them, so you can delete them. See Currency Manager GUI and Categories.