How to set up the TAB plugin

Step by step

1. Install TAB

   Put the TAB jar in plugins and start the server once. TAB writes config.yml, groups.yml and users.yml in plugins/TAB/.

2. Set the header and footer

   In config.yml, find header-footer. Each line is one line of text. TAB has its own placeholders such as %player%, %online%, %ping% and %world%.

   header-footer:
     enabled: true
     designs:
       default:
         header:
           - "&6&lMY SERVER"
           - "&7Welcome, &f%player%&7!  &f%online%&7 online"
         footer:
           - "&7Ping &f%ping%ms   &7World &f%world%"
           - "&eplay.myserver.net"

3. Turn on the scoreboard

   TAB has its own sidebar scoreboard, so you do not need a second scoreboard plugin. Turn off any other one to stop them fighting over the sidebar.

   scoreboard:
     enabled: true
     toggle-command: /sb
     scoreboards:
       main:
         title: "&6&lMY SERVER"
         lines:
           - ""
           - "&7Player &f%player%"
           - "&7Rank &f%group%"
           - ""
           - "&7Ping &f%ping%ms"
           - "&7Online &f%online%"
           - ""
           - "&eplay.myserver.net"

4. Add rank prefixes

   In groups.yml, add one entry per LuckPerms group. tabprefix shows in the tab list, tagprefix above the player's head.

   owner:
     tabprefix: "&c[OWNER] "
     tagprefix: "&c[OWNER] "
   vip:
     tabprefix: "&a[VIP] "
     tagprefix: "&a[VIP] "
   default:
     tabprefix: "&7"
     tagprefix: "&7"

   The names must match your LuckPerms group names.

5. Sort the tab list by rank

   Under scoreboard-teams, list your groups from highest to lowest:

   scoreboard-teams:
     enabled: true
     sorting-types:
       - "GROUPS:owner,admin,mod,helper,vip,default"
       - "PLACEHOLDER_A_TO_Z:%player%"

6. Reload

   Run /tab reload. Changes show up without a restart.

Chat prefixes are separate

TAB changes the tab list and name tags, not chat. For chat, set a LuckPerms prefix and use a chat plugin that shows it, such as EssentialsX Chat:

lp group vip meta setprefix 100 "&a[VIP] "

Using a drawn style

The banner and badges in the picture above are font glyphs from a resource pack. You put them in the TAB lines like any other text, with &f in front so they keep their colours. Players need the pack, so see making a resource pack required.

If it does not work

• Prefixes do not show: the group names in groups.yml do not match LuckPerms, or another plugin also edits the tab list or name tags.
• The scoreboard flickers or vanishes: a second scoreboard plugin is running.
• Placeholders show as text: placeholders like %vault_eco_balance% need PlaceholderAPI and its expansion installed.
• Config error on reload: YAML needs spaces, not tabs, and quotes around lines that start with &.

Questions