Ranks

Ranks

Synchronizing a rank

To start synchronizing a rank, you need to open your config.yml. At the bottom you'll find something like this:

ranks:
  discord:
    administrator:
      minecraft: "admin"
      discord: "Minecraft Administrator"
    moderator:
      name-format: "Mod << %name%"
      minecraft: "mod"
      discord: "Minecraft Moderator"
    vip:
      name-format: "%name%"
      minecraft: "VIP"
      discord:
        - "VIP"
        - "Donator"

those are the ranks that will be synced between your Minecraft server and your Discord server. We'll split up this example into multiple parts to give you a better idea of what this means and why it's formatted like this.

We will begin with the discord part. This means that we want to synchronize Discord. You might say: "Well, that the only platform that I'm able to synchronize", but this field has been added to make sure we can add other platforms in the future. For this reason we DO need to add this field, otherwise it won't work.

After that, we see the administrator, moderator and vip fields. These are just the unique names that are easy for you to recognize. As long as they're unique, the plugin doesn't matter, so you could also give those things names in your own language, but DO make sure that they're unique for every rank that you want to sync.

Then we've arrived at the most import part of this setup. The minecraft and discord fields. Those are the names of the ranks that you want to sync. At first, we'll talk about this minecraft field. This field is case-sensitive so please make sure that you write it correctly otherwise the plugin won't be able to use this rank. The discord field is case-insensitive, so you can play with the UPPERCASE and lowercase as much as you want to but the other parts of the name should be like you named the rank in your Discord server. As you can tell by looking at the VIP discord field, it is possible to sync one Minecraft rank to multiple Discord ranks.

Besides that you might have noticed that some name-format fields have been given. This is the format which will be applied to users which have access to this role, when the name-sync feature has been enabled. This overrides the globally given name-format for this specific group. When it has not been defined, the globally defined name-format will be used for members of this group.