Skip to content

Commands

Jump to bottom
lokka30 edited this page Jan 4, 2025 · 1 revision

Note

This page is accurate as of Polyconomy v0.4.1.

This page describes how to use Polyconomy's commands.

Most commands supplied with Polyconomy are super simple to use; most players who have used EssentialsX's economy (for instance) will feel at home with the /bal, /baltop, /pay, and /eco commands for players and admins to interact with the server's economy. Polyconomy expands these with multi-currency functionality and other features.

/bal

Usage:

  • /bal [player] [currency]
  • e.g., /bal lokka30
  • e.g., /bal stumper66 tokens

Permissions Required:

  • (Not yet edited here!...)

The balance command (/balance, or /bal as a short alias) is used to check your balance (or for another player's, online or offline).

By default, it will check the primary currency used on the server. If the server offers multiple currencies, then you are able to check the balance of different currencies for the player by specifying the currency name in the currency argument (optional).

Simples!

/baltop

Usage:

  • /baltop [page] [currency]
  • e.g., /baltop
  • e.g., /baltop 3
  • e.g., /baltop 1 tokens

Permissions Required:

  • (Not yet edited here!...)

Displays a leaderboard of players by their wealth in whichever currency is specified (if not specified, the primary currency is assumed). You can specify a page number if you want to see more entries, e.g., 2 for the second page.

/pay

Usage:

  • /pay [player] [amount] [currency]
  • e.g., /pay Oathkeeper 123.45
  • e.g., /pay squeebo 1000 tokens

Permissions Required:

  • (Not yet edited here!...)

Pays the specified player the specified amount in the specified currency.

Lots of specificity. Anyhow, it's another simple and familiar command.

/eco

Usage:

  • /eco <subcommand> ...
  • See subcommands below. Usage depends on what subcommand is used.

Permissions Required:

  • (Not yet edited here!...)

This is where we get the big guns out...

The /eco command is mostly used to manage the economy (being the data, the plugin itself, ... all of it).

See the subcommands below you can run.

/eco backup

  • NOT YET IMPLEMENTED
  • Requires permission (Not yet edited here!...).
  • Automatically copies your config files (and the data directory, if present) into a backup directory inside the plugins/Polyconomy/ directory. Useful if you need to quickly add a safety net to something dangerous ... like dropping some tables in the database.

/eco currency

  • NOT YET IMPLEMENTED
  • Requires permission (Not yet edited here!...).
  • Massive subcommand and I don't have time to write about it.
  • Oh, it's also heavily in development, so you should probably stay away from it for now, unless you know what you're doing!

/eco deposit

  • Aliases: give, add
  • Usage:
    • /eco give <player> <amount> [currency]
    • e.g., /eco give lokka30 123456.78
    • e.g., /eco give stumper66 999 tokens
  • Requires permission (Not yet edited here!...).
  • Gives the player money in the primary or specified currency. Generates it out of thin air! Generate inflation on your server today.

/eco reload

  • Aliases: rl
  • Usage:
    • /eco rl
  • Requires permission (Not yet edited here!...).
  • Soft-reloads the plugin, having the convenience of not restarting your whole server. This involves:
    • Reloading the configs, making your changes to those files take effect.
    • Reconnecting to the database or other storage option.
    • Re-registering all plugin hooks e.g. Vault.
    • Restarting all running sub-tasks, such as the database cleanup task.

/eco reset

  • Usage:
    • /eco reset <player> [currency]
    • e.g., /eco reset Oathkeeper
    • e.g., /eco reset jwevans tokens
  • Requires permission (Not yet edited here!...).
  • Sets the player's balance in the primary or specified Currency to be the default starting balance for that currency, e.g., $50 by default for the dollar currency.

/eco set

  • Usage:
    • /eco set <player> <amount> [currency]
    • e.g., /eco set squeebo 123.456
    • e.g., /eco set lokka30 789 tokens
  • Requires permission (Not yet edited here!...).
  • Sets the player's balance in the primary or specified Currency to be the specified amount.

/eco subroutine

work in progress!

/eco version

  • Aliases: about, info, ver
  • Usage:
    • /eco ver
  • Displays the plugin name, version, and authors.

/eco withdraw

  • Aliases: take, remove
  • Usage:
    • /eco take <player> <amount> [currency]
    • e.g., /eco take lokka30 123456.78
    • e.g., /eco take stumper66 999 tokens
  • Requires permission (Not yet edited here!...).
  • Removes the specified amount from the specified player's balance in the specified currency. The player must be able to afford the withdrawal in that currency. The money vanishes into thin air.

Back to Wiki homepage.

Discord Server

Clone this wiki locally