Ranks Setup

Ranks Setup

This page will give you all the information you need to change the ranks part of your configuration file(ranks.yml). This page only shows how to set up the configuration file. If you want to know more about the ranks and experience system, go to Basic Tutorials and check the ranks and experience parts.

---

Settings

This part of the config file allows you to modify all settings of the experience and ranks system.

• enable: If set to true, the experience and ranks system will be enabled. If set to false, the entire system will be disabled such as commands, rewards,...

• rank-perms-inheritance: If set to true, if a player has a duel rank, he will inherit the permissions from the previous ranks. If set to false, the player will only have the permissions of his rank.

• ranks-perms-checker: If set to true, a player will not be able to have permissions from higher ranks than his own. If set to false, the player will be able to keep those permissions if he levels down or if you reset his progression.

• no-rank-name: The message to show in the profile if a player doesn't have any rank or if there is no rank in the config file.

• progression: This part of the config is about the progression of players, such as rewards, level-up, and rank-up settings, and more.

  • level-formula: Mathematical formula used to calculate the number of experience points required by the level. For reasons of mathematical consistency, please make sure that the formula used returns 0 if the level is 0.

    • Note: If you want to use the mathematical power symbol, do not use the symbol "^" but write: Math.pow(number, exponent). For example, if you want to put 1.025^%level% (as in the default config), you need to write Math.pow(1.025, %level%).
    • Available Placeholders: %level% - The level value (variable).

  • rank-up-actions: All these actions will be sent when a player ranks up. TIPS: As timer settings, you can remove actions you don't want. Also if you don't want any of these actions to be sent when a player ranks up. Delete the rank-up-actions part.

    • message-to-players: Send a message to the player who ranked up.
      • Available Placeholders: %rank% - The name of the rank, the player just reached.
    • title-to-players: Show a title and a subtitle to the player who ranked up. The first line must be the title and the second the subtitle.
      • Available Placeholders: %rank% - The name of the rank, the player just reached.
    • sound-to-players: Play a sound to the player who ranked up.
      • sound-id: Sound ID can be found by googling "SPIGOT SOUND <your-server-version>". You can find the last-update sounds here.
      • volume (optional): The sound volume.
      • pitch (optional): The sound pitch.
    • actionbar-to-players: Show an action bar to the player who ranked up.
      • Available Placeholders: %rank% - The name of the rank, the player just reached.
    • broadcast: Broadcast a message to the server.
      • Available Placeholders: %rank% - The name of the rank, the player just reached. %player% - The name of the player.

  • level-up-actions: All these actions will be sent when a player levels up. TIPS: As timer settings, you can remove actions you don't want. Also if you don't want any of these actions to be sent when a player levels up. Delete the level-up-actions part.

    • message-to-players: Send a message to the player who leveled up.
      • Available Placeholders: %level% - The level the player just reached.
    • title-to-players: Show a title and a subtitle to the player who leveled up. The first line must be the title and the second the subtitle.
      • Available Placeholders: %level% - The level the player just reached.
    • sound-to-players: Play a sound to the player who leveled up.
      • sound-id: Sound ID can be found by googling "SPIGOT SOUND <your-server-version>". You can find the last-update sounds here.
      • volume (optional): The sound volume.
      • pitch (optional): The sound pitch.
    • actionbar-to-players: Show an action bar to the player who leveled up.
      • Available Placeholders: %level% - The level the player just reached.
    • broadcast: Broadcast a message to the server.
      • Available Placeholders: %level% - The level the player just reached. %player% - The name of the player.

  • level-up-reward-commands: Run reward commands as the console when a player level up. (Supports multiple lines)

    • Available Placeholders: %player% - The name of the player. %amount% - The amount of time the command will be sent (depending on how much time the player leveled up) so don't use static value (numbers).

  • maximum-level: The maximum level players can reach.

  • cooldown: Amount of seconds players must wait after gaining experience points with a duel before they are able to earn points again.

  • duel-reward: This part is about experience points players can win after playing in a duel. You can set fixed values (eg. 10, 250, 1234) or a range (eg. 10-20, 250-500, 1234-2345). You need to use integer value.

    • winner-range: The number of experience points the winner of a duel will be able to win.
    • no-winner-range: The number of experience points both dueling players will be able to win if there is no winner.
    • loser-range: The number of experience points the loser of a duel will be able to win.

Ranks

This part of the config file allows you to create as many ranks as you want, depending on the level.

• level: To create a rank you need to put the level of the rank as the rank section (see the default configuration file). If a player reaches this level, he will have the rank related to this level.

  • name: The name of the rank.

  • permissions: List of permissions a player will receive if he reached this rank (Supports multiple lines). You can use existing permissions or create new ones.

  • reward-commands: Run reward commands as the console when a player reached this rank (Supports multiple lines).

    • Available Placeholders: %player% - The name of the player.