Economy Support - File14/ProCosmetics GitHub Wiki
ProCosmetics allows you to integrate ProCosmetics coins with other economy-supporting plugins such as EssentialsX (via Vault), Player Points and more.
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.
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
- Set the economy
type
toBUILT_IN
in yourconfig.yml
.
- Restart the server, and ProCosmetics will use its built-in economy system.
- Make sure you have downloaded and installed Vault onto your server.
- Make sure the economy
type
is set toVAULT
in yourconfig.yml
.
- Restart the server and ProCosmetics will now use Vault for coins.
- Make sure you have downloaded and installed Player Points onto your server.
- Make sure the economy
type
is set toPLAYER_POINTS
in yourconfig.yml
.
- Restart the server and ProCosmetics will now use Player Points for coins.
- Develop or use a custom plugin that hooks into ProCosmetics API. Implementation example: 1. Implement IEconomyProvider. 2. Register it!
- Make sure ProCosmetics is set as
depend
orsoft-depend
in your custom plugin to ensure correct load order.
- Set the economy type to
CUSTOM
in yourconfig.yml
.
- Restart the server, and ProCosmetics will now use the custom economy system provided by your plugin.