Quick Start

Get Obfeco running with a working Vault currency in about five minutes.

1. Install

Drop the jar in plugins/, add Vault (or VaultUnlocked) and PlaceholderAPI if you use them, and start the server. See Installation for the full walkthrough.

2. Meet the default currency

On first start Obfeco creates one currency, plugins/Obfeco/currencies/dollars.yml:

yaml 
display-name: Dollars
symbol: $
format: '%symbol%%amount%'
material: GOLD_INGOT
starting-balance: 0.0
use-decimals: true
notify-give: true
notify-take: true

config.yml already points Vault at it:

yaml 
vault:
  enabled: true
  primary-currency: dollars

Every Vault plugin on the server (shops, jobs, EssentialsX /pay) now reads and writes dollars.

3. Create a second currency

From the console or in-game:

/obfeco create gems Gems 0 false

That makes a gems currency with no starting balance and whole numbers only. Or run /obfeco manage, click the emerald, and type a name on the sign. See Currency Manager GUI.

4. Try the core commands

/obfeco help                      # commands you have access to
/obfeco give Steve gems 250       # give a player currency
/obfeco balance Steve gems        # check someone's balance
/obfeco top gems                  # leaderboard
/obfeco reload                    # apply config edits

Full reference: Commands & Permissions.

5. Give players access

obfeco.use is granted to everyone, but the player commands (balance, pay, top) default to op. Grant them with your permissions plugin, for example with LuckPerms:

/lp group default permission set obfeco.balance true
/lp group default permission set obfeco.pay true
/lp group default permission set obfeco.top true
/lp group default permission set obfeco.top.gui true

Where to go next