Installation

  1. Check the Requirements — Java 17+, Paper/Purpur/Folia 1.20+.
  2. Download the latest jar from Modrinth.
  3. Drop the jar into your server's plugins/ folder.
  4. Optional: install Vault (or VaultUnlocked) and PlaceholderAPI. Obfeco hooks into both on start.
  5. Start (or restart) the server. On first run Obfeco creates plugins/Obfeco/:
    • config.yml — storage, caching, formatting, Vault, PlaceholderAPI and logging settings.
    • messages.yml — every player-facing message and GUI label, plus the global prefix.
    • categories.yml — optional currency categories for the Currency Manager GUI.
    • currencies/ — one YAML file per currency, starting with dollars.yml.
    • data.db — the SQLite database (default storage).
  6. Edit whichever files you need (see Configuration).
  7. Apply changes without restarting: /obfeco reload (permission obfeco.reload).

Verifying it's working

Run /obfeco help in-game or from the console. You'll see every subcommand you have permission for. Then:

  • /obfeco balance <you> dollars — confirms storage is reading balances.
  • /papi parse me %obfeco_dollars_balance% — confirms the PlaceholderAPI expansion is registered.
  • /vault-info (Vault) — the economy line should read Obfeco.

Obfeco is quiet at startup: logging.console is false by default, so the console only shows warnings and errors. Set it to true if you want the "Hooked into Vault" and load-time lines.

Updating

Replace the jar and restart. Your config, messages, categories and currency files are kept as they are. messages.yml keys added in a newer version fall back to the bundled defaults, so an older messages.yml keeps working without being regenerated.

Upgrading from a version before 26.10 converts stored balances to the current layout on first start. See Migration Guide → Upgrading from before 26.10.

Avoid /reload and plugin managers. Use /obfeco reload for config changes and a full restart for jar updates.

Uninstalling

Remove the jar and restart. plugins/Obfeco/ (configs, currency files, the SQLite database and transaction logs) stays on disk. Delete it yourself for a clean removal. MySQL tables (obfeco_balances, obfeco_players, obfeco_meta) also stay until you drop them.