Bukkit

Ever wanted a simple way to list all of the players on your server in their ranks? With PlayerList you can do just that, and more!

Features

PlayerList comes with two important features:

• Changing the color of player names in the Tab list to their ranks defined in the config
• Showing players in their ranks defined in the config

Downloads

Latest version

GitHub Source

Setup

The first section of the config is pretty self explanatory but comes with its comments to help you anyway. Still, here's all you need to know about setting it up and using it:

The first thing you need to do is get Vault. Why? This plugin uses vault to get the groups of players, since bukkit has no direct method of doing so.

After you install vault, you need to set up your config. The plugin will work without doing so but as long as you haven't defined the ranks in the config, you won't get very far. Here's how to set up the first half:

PlayerList:
  global-players:
    one-player: '&bThere is &a%players &bplayer online:'
    more-players: '&bThere are &a%players &bplayers online:'
  change-tablist: true
  use-displayname: true
  show-on-same-line: true

So what does all this mean? Well, I'm pretty sure you can guess what the first section says. It basically defines the message to display how many players are online. In this message you can use any color code and refer to the amount of players online using the %players tag. You don't need the tag for the one-player section as you can just as easily type "There is 1 player online:" but it's there for convenience.

Next is change-tablist. Setting this to true will change the colors of everyone's name to whatever their rank is in the ranks section. Setting this to false will keep the tablist untouched.

Then there's use-displayname. In bukkit, there are two ways to get the name of a player. DisplayName is the name of the player as it appears on the screen. So if you have any prefixes defined or other nickname settings enabled, it will get the nickname. Setting this to false will return the exact full name of the player.

show-on-same-line. This shows the player list of that specific rank on the same line as the rank. Setting this to false will show the player list on the next line.

Okay, that wasn't so bad. Here's where things get a little more interesting though:

  ranks:
    Administration:
      color: '&f'
      admin: '&4'
      moderator: '&3'
    Default:
      color: '&f'
      default: '&7'

Okay. Let me break this down into sections:

Administration:

This is the name of the rank that will appear when someone types /list. It can be called anything as long as it doesn't have a space in it, but for the sake of even downloading the plugin I'm sure you'd call it something relevant.

color: '&f'

This is that color of the name of the rank that appears in the chat. So in this example, when players type /list, they'll get:

Administration (#):

And this will be white. the # will be the number of players online in that group.

admin: '&4'
moderator: '&3'

This is the trickiest part to understand. Lets break it down and forget about the color codes for now. Basically, this says "All players in the admin and moderator groups will be shown in the Administrator section".

Lets say player "Foo" is an admin and "Bar" is a moderator, and that they're both online. This is what players would see when they type /list:

Administration (#): Foo, Bar

So what about the color codes next to the rank names? Simple. If you have use-displayname set to false, it will change the color of players names to whatever you put in the color code section. So in the above example, since Foo is a member of the admin group and Bar is a member of the moderator group, Foo's name will be dark red and Bar's name will be dark aqua.

  ranks:
    Administration:
      color: '&f'
      admin: '&4'
      moderator: '&3'
    Default:
      color: '&f'
      default: '&7'

So this is much easier to understand now. You can also put players in other groups so they will show up there too, which is pretty pointless in the long run. But possible.

Additionally, the ranks shown when /list is run will be shown in order of the config. So the Administration section will be displayed first, then the Default. As well as this, if there is nobody online who belongs in one of these groups, that group is skipped and the next one is checked, so you don't get empty lists ingame.

Here's a screenshot of the setup I have running for ba55ment.org, a sever I co-own:

And here's the config for that setup:

PlayerList:
  global-players:
    one-player: '&bThere is &a%players &bplayer online:'
    more-players: '&bThere are &a%players &bplayers online:'
  change-tablist: true
  use-displayname: true
  show-on-same-line: true
  ranks:
    Admin:
      color: '&f'
      admin: '&4'
    Moderator:
      color: '&f'
      moderator: '&3'
    Architect:
      color: '&f'
      architect: '&a'
    Trusted:
      color: '&f'
      trusted: '&6'
    Supporter:
      color: '&f'
      ddefault: '&7'
      dtrusted: '&6'
      darchitect: '&a'
      dmoderator: '&3'
    Default:
      color: '&f'
      default: '&7'

As you can see we have a donator rank for each other rank on the server. We changed the name to supporter in this config though.