Economy Support - File14/ProCosmetics GitHub Wiki

Economy Support

ProCosmetics allows you to integrate ProCosmetics coins with other economy-supporting plugins such as EssentialsX (via Vault), Player Points and more.

Configuration

In your config.yml, you can currently choose from the following economy types:

  • BUILT_IN - Use ProCosmetics default built-in economy system.
  • VAULT - Integrate your ProCosmetics coins with Vault-supporting plugins.
  • PLAYER_POINTS - Use Player Points as your economy system.
  • CUSTOM - FOR DEVELOPERS ONLY! Hook a custom economy system via the plugin API. See the examples below.

NOTE: If you use any economy type other than the built-in system, coins will NOT be synced by ProCosmetics MySQL feature. You are responsible for storing and syncing these coins.

Example Configuration

To set your desired economy type, modify the config.yml file as follows:

economy:
  # Types: VAULT, PLAYER_POINTS, BUILT_IN or CUSTOM (hooked via plugin API)
  type: VAULT

Setting Up Each Economy Type

Built-in Economy

  1. Set the economy type to BUILT_IN in your config.yml.
  2. Restart the server, and ProCosmetics will use its built-in economy system.

Vault

  1. Make sure you have downloaded and installed Vault onto your server.
  2. Make sure the economy type is set to VAULT in your config.yml.
  3. Restart the server and ProCosmetics will now use Vault for coins.

Player Points

  1. Make sure you have downloaded and installed Player Points onto your server.
  2. Make sure the economy type is set to PLAYER_POINTS in your config.yml.
  3. Restart the server and ProCosmetics will now use Player Points for coins.

Custom Economy

  1. Develop or use a custom plugin that hooks into ProCosmetics API. Implementation example: 1. Implement IEconomyProvider. 2. Register it!
  2. Make sure ProCosmetics is set as depend or soft-depend in your custom plugin to ensure correct load order.
  3. Set the economy type to CUSTOM in your config.yml.
  4. Restart the server, and ProCosmetics will now use the custom economy system provided by your plugin.
⚠️ **GitHub.com Fallback** ⚠️