Configuration Guide

This guide aims to help you with configuring the plugin to your needs

Understanding The Configuration

When you want to edit the configuration, you will find 3 files those are config.yml, data.yml and messages.yml, and they are all self-explanatory for what they contain.

This is what the config.yml will look like upon opening it for the first time

redeemables:
  example:
    timesCanRedeem: 5 # Makes this item redeemable 5 times
    permission: "redeem.example"
    commands:
      - "eco give %player% 10"

Breaking down the config

Here we will break down the configuration file to allow you to understand it, it's very simple!

redeemables:
  example: # this will be the name of the redeemable (e.g. /redeem example)
    timesCanRedeem: 5 # This is how many times they can use the redeemable
    permission: "redeem.example" # This is an optional option, but this allows you to set the permission they need to use the redeemable, if you don't want a permission node, just delete this!
    commands: # This is what commands will get run when a player redeems a redeemable
      - "eco give %player% 10"

Adding more redeemables

Adding more redeemable is super simple! It's just the case of copying the example, and renaming it, and making it to your liking! Here is an example:

redeemables:
  example:
    timesCanRedeem: 5 # Makes this item redeemable 5 times
    permission: "redeem.example"
    commands:
      - "eco give %player% 10"
  myotherredeemable:
    timesCanRedeem: 2
    permission: "redeem.1k"
    commands:
      - "eco give %player% 1000"

Editing messages

Editing the messages is as simple as going into the messages.yml and editing the variables!

Whats the data.yml for?

The data.yml file stores all the times a player has redeemed a redeemable, this stores it in a format that is quite easy to understand: PLAYER UUID:TIMES RUN.

It isn't recommended that you edit this file as you will get no support if the plugin breaks due to you editing this file