Skip to content

Getting Started

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

Note

This page is accurate as of Polyconomy v0.4.1.

This page helps you get started with using and understanding Polyconomy.

Prerequisites

Important

Read the Requirements page before installing Polyconomy to make sure your server will likely work with the plugin.

Installation

  • Download Polyconomy from your preferred official site e.g. Spigot / Hangar / GitHub.
  • Move the downloaded plugin JAR file into your plugins/ directory.
  • Install an Economy API.
    • Vault API currently has the widest plugin coverage. You can use VaultUnlocked (RECOMMENDED), OR (but not both), Vault (legacy). Do not use both at the same time.
    • You may also be interested in using Treasury (works alongside Vault legacy/unlocked, and does not replace them, separate entirely, quite niche at the moment).
  • Start up your server.
    • This will let Polyconomy do its first run and generate its default configs for you.

Post-Installation

You can optionally modify the currencies and default starting balance ($50) on your Polyconomy installation by using the command /eco currency (read more here).

Optionally, configure Polyconomy to your desire in the plugins/Polyconomy/ directory.

The plugin offers multiple data storage systems you can use:

Identifier Name Local/Remote? Type Stability Notes
h2 H2 local database Stable Default. Recommended for single server setups.
json JSON local flatfile Stable Only useful for debugging or plaintext control over economy data.
yaml YAML local flatfile Stable ^^^

Note

More options are planned for the near future, such as MySQL / PostgreSQL remote databases.

Warning

Please note, you are unable to migrate data between them at this time, so please choose a 'future proof' option for your server on first setup.

What storage option do I choose?

  • If you only plan on using just your single server (no network via Velocity/BungeeCord etc), the H2 storage option is almost always the best.
  • Otherwise, usually MySQL (if/when available) would be the best choice.
  • If there's another option that's listed above that you prefer (and it's efficient enough for your server), by all means, use it! 😃

How do I change the storage option I'm using?

  • Open settings.yml (in plugins/Polyconomy/) with your preferred text editor.

  • Change value of the implementation setting inside the storage area of settings.yml to be the id value listed above.

    • For example, use h2 for the H2 storage option (enabled by default).

  • If you've chosen a remote database option (or otherwise if your choice requires additional configuration), please adjust the values as necessary.

    • For example, for MySQL / PostgreSQL / etc, you'll need to configure the username, password, database name, and other details in the database settings under the storage area of settings.yml.

  • We recommend against adjusting the default values of cleanup-task...

    • ... unless you know exactly what you are doing and benefit from increased or decreased DB operations depending on your adjustment as you see fit.
    • The vast majority of you should leave those settings alone!

This page missing something? Please let us know any feedback so we can improve the documentation to be more useful for you.

Back to Wiki homepage.

Discord Server

Clone this wiki locally