Skip to content

Home

Jump to bottom
Silal edited this page Apr 25, 2025 · 15 revisions

If you need help contact me on my socials:

Features

  • create custom ranks
  • assign ranks to players
  • custom chat format for messages
  • create custom join or quit messages
  • assign ranks to groups with permissions
  • PlaceholderAPI support

Commands

A list of all existent commands.

/sr - opens the gui if you have permission
/sr help - show help menu
/sr gui - opens the gui
/sr rank create {name} {color} - is used for rank creation!
/sr rank delete {name} - is used to delete Ranks
/sr rank info {name} - is used to collect the Informations of a rank
/sr rank list - is used too lookup all Ranks
/sr rank modify {moveUp/moveDown} - is used to set the rank position higher or lower
/sr rank modify {key} {value} - is used for further rank Modification
/sr config {key} {value} - is used for Default configurations

/broadcast {rank} {message} - to broadcast a message to a specific rank

/rank {playerName} get - is used to get the rank of a player
/rank {playerName} set {rank} - is used to set the rank of a player
^ Optional {timer} if enabled

Config

A guide how to write the config.json!

DefaultConfig: 

{
  "defaultRank": "Player", //Name of the default Rank
  "defaultGroup": "Default", //Name of the default Group every Rank gets assignerd
  "rankTimer": false, //If the rank timer is enabled (/rank  set  ) <- this timer option
  "rank": {
    "chatFormat": "%rank_color%%rank_dpname% \u00268»\u0026f %player_name%\u00268:\u00267 %message% ", //Format of the chat messages
    "chatRank": true, //If the chat format is enabled
    "teamSeparator": "§7»", //The seperator in the tablist between the rank and name
    "teamRank": true, //If the rank in tab list is enabled
    "teamRankPlayerNameColor": "f", //The color of the playername in tablist
    "quitMessage": true, //It the quit message is enabled
    "quitMessageFormat": "\u0026c- %rank_color%%player_name% ", //Format of quit message
    "joinMessage": true, //If the join message is enabled
    "joinMessageFormat": "\u0026a+ %rank_color%%player_name% " //Format of the join message
  }
}

defaultRank
The defaut rank is automaticly created on reload/get

rankTimer
This is used to turn on the /rank {player} set {rank} {time} <- time or turn it off

rank.chatFormat
Is the format of messages in Chat.

How to use the Values:

  • {rank_color} - color of the players rank
  • {rank_dpname} - is replaced with the players rank name
  • {player_name} - is replaced with the players name
  • {message} - is replaced with the players message

rank.chatRank
Is a value if you want to use your custom format or not!

rank.teamSeperator
Is a value wich u can see above a players head and in the tablist between the Rank and the name. Default: "»"

rank.teamRank
is a value if u want the rank in tab and above a players head.

Permissions

A list of all existent permissions.

simpleranks.config
When you have this permission you can use the /sr config {key} {value} command!

simpleranks.playerrank.get
When you have this permission you can get the rank of a player using /rank {playerName} get

simpleranks.playerrank.set
When you have this permission you can set the rank of a player using /rank {playerName} set {rank}

simpleranks.playerrank.set.all
When you have this permission you can set all ranks using /rank {playerName} set {rank}

simpleranks.rank.create
When you have this permission you can create new ranks using /sr rank create {name} {color}

simpleranks.rank.delete
When you have this permission you can delete ranks using /sr rank delete {rank}

simpleranks.rank.list
When you have this permission you can see a list of all ranks using /sr rank list

simpleranks.rank.modify
When you have this permission you can use the /sr rank modify {rank}

simpleranks.rank.info
When you have this permission you can use the /sr rank info {rank} command to get info about a rank

Api

Example api code:

public final class Simplerankstest extends JavaPlugin {

    @Override
    public void onEnable() {
        RankAPI api = SimpleAPI.getApi(); // Get the api

        Player p = Bukkit.getPlayerExact("Silal");
        PlayerConfiguration config = api.getPlayer(p);
        p.sendMessage(config.getRank().color() + config.getRank().displayName());
    }

    @Override
    public void onDisable() {
        // Plugin shutdown logic
    }
}

Examples

Tablist:

Chat:


Gui:



Clone this wiki locally