Currencies

Overview

The currency system allows you to create custom currencies for your server. Each currency is defined by a YAML file in the currencies/ folder, where the filename (without .yml) becomes the currency ID. Currencies can integrate with Vault for compatibility with other plugins.


Basic Currency Settings

max-value

  • Value: 0 (unlimited)

  • Description: Maximum amount a player can have of this currency

  • Options:

    • 0 = No limit

    • Any positive number = Maximum amount allowed

starting-value

  • Value: 0

  • Description: Amount of this currency new players start with

display-name

  • Value: 'Money'

  • Description: The display name shown to players for this currency

  • Supports: Color codes with &


Vault Integration

vault-currency

  • Value: true or false

  • Description: Whether to register this currency with Vault economy system

  • Benefits:

    • Allows other plugins to interact with this currency

    • Enables use in shops, auction houses, and other economy plugins

    • Provides standardized economy commands


Command Configuration

Main Command

commands.main.permission

  • Value: '' (empty = no permission required)

  • Description: Permission required to use the main currency command

commands.main.command

  • Value: money

  • Description: The main command name for this currency

commands.main.aliases

  • Value: [] (empty array)

  • Description: Alternative command names

  • Example: ['bal', 'balance', 'cash']

Balance Commands

commands.balance.permission

  • Value: '' (empty = no permission required)

  • Description: Permission to check own currency balance

commands.balance.balance-other-permission

  • Value: 'eddungeons.balance.others'

  • Description: Permission to check other players' currency balance

Administrative Commands

commands.give.permission

  • Value: 'eddungeons.balance.give'

  • Description: Permission to give currency to players

commands.set.permission

  • Value: 'eddungeons.balance.set'

  • Description: Permission to set a player's currency amount

commands.remove.permission

  • Value: 'eddungeons.balance.remove'

  • Description: Permission to remove currency from players


Usage Examples

Player Commands

Main Currency Command:

  • /money - View current balance

  • /money balance - Check your balance

  • /money balance <player> - Check another player's balance (with permission)

Administrative Commands:

  • /money give <player> <amount> - Give currency to a player

  • /money set <player> <amount> - Set a player's currency amount

  • /money remove <player> <amount> - Remove currency from a player

Last updated

Was this helpful?