This plug-in is controlled through .json configuration files.

After you reload or restart your server, you will be provided with the following files:

• /plugins/PayRank/config.json
• /plugins/PayRank/payranks.json
• /plugins/PayRank/resources.json

Open these and and edit as you please. Below are details on each section of the .json files.

Some helpful links:

GSON - Bukkit's built-in JSON parsing library.

JSONLint - Tool for validating your JSON files.

Important Notes

• The order of each rank in the .json configuration also defines the progression order of the ranking system.

• The group value MUST match the same one found in group in your permissions.yml.

File: resources.json

This configuration file is used for the plug-in resource settings.

I won't go into detail on each entry here, but will give a quick overview on how to use it. An example from the file:

{
  "messages": {
    "payrank.promote.completed.sender": "<player> has been promoted to the rank of: <rank>"
}

payrank.promote.completed.sender is the name of the resource. DO NOT change this.

The next part is where you can change the text to be whatever you want. The <player> and <rank> are replaced with the player name and rank name accordingly.

These are not consistent through each resource. Many resources do not need them and thus do not parse them. The default configuration shows which placeholders can be used for that resource.

File: config.json

This configuration file is used for the plug-in global settings.

Default:

{
	"chatFormattingEnabled": true,
	"loggingDebug": false
}

Field descriptions:

File: payranks.json

This configuration file is used to define each of the ranks you wish to use.

Template

The template portion of the configuration is used to allow you to define multiple format styles for when the text is placed into the game chat. You can assign a different template to each rank if you want.

Example of template:

{
  "templates": [
    {
      "name": "Template",
      "format": "<[time] [world] [prefix][player][suffix]> ",
      "time": "hh:mm",
      "worlds": [
        {
          "name": "world",
          "displayName": "&e[World]&f"
        }
      ]
    }
  ]
}

Field descriptions:

Format options:

You can move them anywhere, or just fully remove them entirely.

Pay Ranks

A PayRank is where we'll be defining the information used for mapping ranks to groups and their display information The prefix and suffix values can have colours and string elements in as seen below.

Example of template:

{
  "payRanks": [
    {
      "name": "Newbie",
      "group": "newbie",
      "prefix": "&a[Newbie]&f ",
      "suffix": "",
      "template": "Template",
      "price": 10,
      "experience": 10
    }
  ]
}

Field descriptions:

Full Example

For reference, here is an example of a working config.json:

{
  "templates": [
    {
      "name": "Template",
      "format": "<[time] [world] [prefix][player][suffix]> ",
      "time": "",
      "worlds": [
        {
          "name": "world",
          "displayName": "&e[World]&f"
        }
      ]
    }
  ],
  "payRanks": [
    {
      // For this rank, we're going to make it cost money only
      "name": "Newbie",
      "group": "newbie",
      "prefix": "&a[Newbie]&f ",
      "suffix": "",
      "template": "Template",
      "price": 10
    },
    {
      // For this rank, we're going to make it cost both xp AND money
      "name": "Member",
      "group": "member",
      "prefix": "&a[Member]&f ",
      "suffix": "",
      "template": "Template",
      "price": 20,
      "experience": 20
    },
    {
      // For this rank, we're going to make it cost xp only
      "name": "Dedicated",
      "group": "dedicated",
      "prefix": "&a[Dedicated]&f ",
      "suffix": "",
      "template": "Template",
      "experience": 20
    },
    {
      "name": "Professional",
      "group": "professional",
      "prefix": "&a[Professional]&f ",
      "suffix": "",
      "template": "Template",
      "price": 10
    }
  ]
}