RankDisplayNames
By popular demand, RankDisplayNames is a means to add ranks to chat display names for players based on their group or permissions. This was designed as an add-on to the GroupPermsLite light-weight group permission management plugin, but should work with any permission management plugin.
The idea is simple, you create your group permission structure as you like it, then you create your Rank display names complete with colour codes (if you want them), and then add the "ranks.membership.[whatever the rank ID is]" permission to each group you want to have a display prefix. Any player you add to that group, or assign that permission will have that rank. Simple, easy, no fuss, just set it up and get on with running your server.
Important note: This is an ADD-ON for a group permission management plugin, as such it DOES NOT handle adding players to Ranks. For that you must have installed and know how to use a permissions plugin to grant players the ranks.membership.[rank ID] permission for that rank
If you are not familiar with Bukkit permissions, you can read up on them here: Understanding Permissions and in the FAQ
If you have any trouble, you can find detailed instructions in the Tutorial
Features
- Simple and easy to manage ranks
- Clear and concise command descriptions
- Ability to create, edit and delete ranks while the server is running
- Advanced users can manage ranks offline using the config YAML
- Ranks tie in with the Bukkit permissions system, so can be assigned to players or groups using permissions
- Supports colour codes for ranks using the % sign as well as §
- Players holding to a rank will have it prefixed to their chat display name
- Detects rank changes for players within a second and updates their display names accordingly
- Sets player list names to match rank colour
- If the TagAPI is installed, also sets player overhead name colour to match the rank
- Supports LanguageAPI for international and multi-language servers (see Translations)
Possible Future Features
- Full customisation for display names, including suffixes and possibly string mutations
- Separate customisation for list tab names, including the option not to interfere with either name for compatibility with other plugins
Commands
Command | Permission | Description |
---|---|---|
/RankCreate [rank ID] [display name] | ranks.commands.rankcreate (default op) | Creates a new rank with the given ID and display name. Display names can contain colour codes and spaces, IDs cannot |
/RankDelete [rank ID] | ranks.commands.rankdelete (default op) | Deletes an existing rank |
/RankEdit [rank ID] [display name] | ranks.commands.rankedit (default op) | Changes the display name for an existing rank. Display names may contain colour codes and spaces |
/RankList | ranks.commands.ranklist (default op) | Displays all ranks with their permissions and display names in order of precedence |
/RankReload | ranks.commands.rankreload (default op) | Reloads ranks from the config.yml, allowing you to load in changes to it without restarting the server |
Permissions
- ranks.admin (default none) - Grants all ranks.commands permissions
- ranks.membership.[rank ID] (default none) - [rank ID] should be replaced with the rank ID, grants membership to a rank
Installation
- Unzip RankDisplayNames.zip into your plugins directory
- (Optional) If you want overhead display name colours, download and install TagAPI
- (Optional) If you want to provide support for other languages, download and install LanguageAPI
- Restart your server
Tutorial
Compatibility and Troubleshooting
This plugin will not be compatible with any other plugin that changes player display names, list names or overhead names. If you can, turn those features off, or disable those other plugins before enabling RankDisplayNames.
This plugin uses Java 7
If you get the followed error on starting up the server with this plugin installed "Unsupported major.minor version 51.0". This means you are using an out of date version of Java. If you don't know how to upgrade, please contact your server hosting provider and ask them for help in upgrading to Java 7, or contact Oracle customer support. Mac OS X users require JDK 7 instead of JRE 7.
Donations
If you'd like to contribute towards the continued development, support and maintenance of this project, please consider joining me on Patreon, and making a one-time or recurring pledge.
Help
If you need help you can leave a comment below and I will get back to you as soon as I can. You can also join my IRC chatroom using the following link. Please note, I am not always at my keyboard! http://webchat.esper.net/?channels=XHawk87&prompt=1
the commands work and i set up the ranks but the ranks just dont show up in the chat.
@Necromedes
You can use this with either GroupPermsLite or PermissionsBukkit to change overhead name tag colour and add chat display prefixes. Just create a Rank for a particular group and then add the ranks.membership.[rank id] for that rank to the group that you want to have that display name/colour.
See the tutorial for detailed instructions: http://dev.bukkit.org/server-mods/rankdisplaynames/pages/tutorial/
I am currently using GroupPermsLite and Permissions Bukkit. Can I use this to display the name of what group a player belongs to overhead and in chatand if not, can you direct me to a plugin that will?
@Pothergust
Please read the red writing and the tutorial.
How do I add someone to the rank?
what command or where??
@canadiancowboy
Please read the red writing and the tutorial
how do you assign a rank to a person
@DaBoltLegend
xdags is correct. Well spotted. This could be an issue with multiple inheritance. Using negative nodes is the correct way to handle it, which GroupPermsLite does support.
An alternative way to handle it, if for some reason you cannot assign negative permissions is to prefix each rankID with a number. Those with a lower number will be given priority when there is a conflict.
@DaBoltLegend
If your ranks are set up to inherit the permissions of the rank below it, you could end up with multiple tags assigned to your higher ranks.
Not sure if it'd work, but you could try restrict the rank permissions.
example:
Where the '-' denotes a restricted permission. Different perms plugins may handle restrictions in different ways.
@DaBoltLegend
The name tags and tab names use the very first two characters (the % and colour id) to determine what colour to make the name. If for instance you used two or more colours for the rank, and the first was red, you would encounter this effect.
Also, RankDisplayNames is not compatible with any other plugin that alters the name tags or tabs names. If you are running a teams plugin for example that changes all red-team players names and list names to red, there is every possibility that the other plugin will change them back to the colour they want after RankDisplayNames has set them.
So I gave my Admin, Sr. Mods, and Moderators a rank, and their name is the right color in chat, but their nametags and tab name are all red! Please help!
Thanks dude! :D
@Eelviny
It does add a space to between every rank and name at present, and there is currently no way to remove it. However for the next release I can provide a feature to allow you to remove the space, without affecting all of the other ranks which are expecting spaces. Possibly adding in an extra character at the end of a rank, such as a backslash.
This is a really nice plugin, almost does the job I need :) However, is there any way to remove the space between the prefix and your name? My formatting means that e.g AdminEelviny, where 'Admin' is blue and 'eelviny' is white.
Sorry
@XHawk87
I am sorry. You have helped me and know i am OK thankyou
@WMPminecraft
If you are asking me how to type a command into a Bukkit, you should be asking that in the Bukkit help forums or the Bukkit Chatroom, rather than spamming my plugin comments with basic questions about Bukkit.
@XHawk87
sorry for the inconvenience but i really do not know where to do the GroupGrantPerms thingy
@WMPminecraft
http://dev.bukkit.org/server-mods/rankdisplaynames/pages/tutorial/#w-setting-up-permissions
@XHawk87
I cannot really find it in the tutorial :/
@WMPminecraft
ranks.membership.[rankID] is a permission. You should replace the [rank ID] part with the ID for the rank you want to add. For instance, if you have a rank with id builder and display name [Builder], you would use ranks.membership.builder to give a player the [Builder] chat prefix.
This IS explained in the tutorial. Please read the tutorial.