Feature guide: Layout
- About
- Creating a layout
- Managing multiple layouts with conditions
- Skins
- Additional settings
- Additional info
- Examples
This feature allows you to customize all 80 tablist slots. Displaying less than 4 columns is currently not supported. This feature can be enabled and configured in layout.yml file.
The feature can be configured in layout.yml file under layouts section. Each layout contains 3 settings: Fixed slots, player groups and display condition (optional).
Condition that must be met for player to see the layout. If player does not meet any condition, next defined layout's condition is checked. If player does not meet any defined display condition, they will see default tablist. Display condition is optional and doesn't need to be set.
For list of possible condition types see Conditions page.
Example:
layouts:
staff:
condition: "permission:tab.staff"
This layout will only be visible to players with tab.staff permission.
These are slots with fixed position that contain configurable text and skin.
They can be configured under fixed-slots option of each layout. The definition syntax is SLOT|TEXT|SKIN. If you don't want to define custom skin for that slot, use SLOT|TEXT.
SLOT - the position of the fixed slot. It can be from 1 to 80. By default, the direction is set to columns, so the first column is 1-20.
TEXT - the text. It supports placeholders.
SKIN - layout's skin, see below for configuration.
Example:
layouts:
staff:
fixed-slots:
- '1|&3RAM&f:'
- '2|&b%memory-used%MB / %memory-max%MB'
- '3|&8&m '
- '4|&3TPS&f:'
- '5|&b%tps%'
These are groups of players which meet the specified condition. They consist of 2 parts - condition and slots.
1. Condition
Condition players must meet to be displayed in the group. If a player doesn't meet condition for group, the next group's condition is checked (groups are checked in the order they are defined in config). If player doesn't meet any codnition, they are not displayed at all. Display condition is not required (can be used for default group).
2. Slots
Slot intervals dedicated to the group. Interval 1-5 would mean all slots from 1 to 5. In case you want to define multiple intervals to exclude some slots, define another interval below the first one.
Example:
layouts:
myLayout:
groups:
staff:
condition: permission:tab.staff
slots:
- '24-40'
players:
slots:
- '44-80'
In this example, slots 24-40 will be reserved for players with tab.staff permission. Players without that permission will be in slots 44-80.
You can define multiple layouts and display them based on a condition. To do so, define condition for layouts. Conditions are checked in the order layouts are defined in config. If layout doesn't specify condition, it is displayed with no requirement. If player does not meet display condition for any layout, they will see the classic tablist.
Example:
layouts:
staff:
condition: "permission:tab.staff"
fixed-slots:
...
groups:
...
default:
fixed-slots:
...
groups:
...
In this example, players with tab.staff permission will see staff layout, others will see default layout.
In slots where players are, their skin is displayed. For fixed slots, if their skin is defined, it is used, otherwise default-skin is used. It is also used if invalid skin is specified anywhere.
Currently, TAB supports 3 skin formats:
mineskin:ID - takes UUID from MineSkin. You can find some pre-uploaded skins at the bottom of this page.
player:name - displays skin of player name
texture:<texture> - uses literal skin texture. This lets you use heads from Minecraft-Heads by taking the texture in the Minecraft-URL field.
Some pre-uploaded Mineskin skins:
BTLP's balance.png: 510604280
BTLP's clock.png: 2053951237
BTLP's server.png: 604037953
BTLP's ping.png: 796704708
BTLP's players.png: 1160612233
BTLP's rank.png: 527763880
Aqua: 1749359849
Black: 1551047136
Blue: 1870064311
Dark Aqua: 1893783461
Dark Blue: 899643609
Dark Gray: 383747683
Dark Green: 588254656
Dark Purple: 2061328517
Dark Red: 924139093
Gold: 1074335506
Gray: 745109047
Green: 224445819
Pink: 1818936290
Red: 1160568696
White: 1105851698
Yellow: 1307755006| Option name | Default value | Description |
|---|---|---|
| direction | COLUMNS | Defines direction of slots. Options are COLUMNS (top to bottom, left to right) and ROWS (left to right, top to bottom). |
| enable-remaining-players-text | true | When enabled, the last slot of player group will show how many more players there are, instead of using the last slot for one more player. |
| remaining-players-text | "... and %s more" | Text to show if option above is enabled. |
| default-skin | "mineskin:1753261242" | Default skin to display for fixed slots that do not define a skin, empty slots and fixed slots with invalid skin. |
| empty-slot-ping-value | 1000 | Ping value to use for fixed slots and empty slots. The ping intervals for bars are client sided and are as following: - Negative value: ✖ - 0 - 149: 5 bars - 150 - 299: 4 bars - 300 - 599: 3 bars - 600 - 999: 2 bars - 1000+: 1 bar |
| hide-vanished-players | true | If enabled, hides vanished players from layout |
To avoid showing fake players in tab-complete, TAB uses an empty string as the fake players' names.
Though Minecraft's scoreboard objectives (which help achieve the Yellow Number feature) only use players' names and not players' UUIDs to define values.
As a result, it is impossible for TAB to assign a different value for each fake player since they all have the same name, making the Yellow Number feature incompatible.
If you still wish to have this effect, use the Aligned Tabsuffix feature as a replacement
The way this feature works is by pushing all real players out of the tablist and showing fake players instead.
As a result, enabling Global playerlist feature won't make any difference, since real players aren't visible in the tablist.
Layout feature is capable of working with all online players connected to the server where TAB is installed, meaning it can show players from all servers when installed on BungeeCord. Because of this, if you use layout, you can just disable global playerlist to reduce resource usage.
The way this feature works is by filling up the tablist with fake players (obviously). However, on bedrock, these fake players can be seen even on places where it's unwanted. For that reason, this feature is automatically disabled for bedrock players.
Plugins using teams and assigning empty player name into them for any purpose they need will break this feature. Since teamless players appear above players with team, TAB is not assigning these fake players into any team to easily solve this. Unfortunately, if another plugin assigns them and team name is alphabetically after team names used by TAB for players, it will break this feature (see #533).
If you have this issue, you'll need to find out which plugin causes it and disable the function in it. Your best bet is to use /teams list and going through teams finding out which one was it. Another option is to use NBT editor and open scoreboard.dat file from your main world's folder. So far I only heard about LibsDisguises doing this (the team is called LD_NoName), though I was not able to reproduce this issue (perhaps it only affects old versions?).
Configuration provided by XDRmc#0001.
enabled: true
direction: COLUMNS
default-skin: "mineskin:1753261242"
enable-remaining-players-text: true
remaining-players-text: "... and %s more"
empty-slot-ping-value: 1000
layouts:
default:
fixed-slots:
- '10|&6Website&7:'
- '11|&fwww.rubymc.land'
- '1|&6User&8:'
- '2|&f%player%'
- '4|&6Rank&7:'
- '5|%vault_group%'
- '7|&6Time & Date&7:'
- '8|&f%server_time_EEE, d MMM yyyy HH:mm:ss%'
- '13|&6Discord&f:'
- '14|&fdiscord.rubymc.land'
- '16|&6Version&7: &f%viaversion_player_protocol_version%'
- '18|&6Ping&7: &f%player_ping%ms'
- '20|&6Network level&7: &6%alonsolevels_level_format%'
- '21|&bServer Info&7:'
- '23|&bUptime&7: &f%server_uptime%'
- '25|&bTPS&7: &f%server_tps_1_colored%'
- '27|&bServer ID&7: &fmini01B'
- '41| &8[&e%online% &6Player online&8]'
groups:
staff:
condition: permission:tab.staff
slots:
- '24-40'
players:
slots:
- '44-80'
Configuration provided by Sappy#8123.
Also using a custom animation.
enabled: true
direction: COLUMNS
default-skin: "mineskin:1753261242"
enable-remaining-players-text: true
remaining-players-text: "... and %s more"
empty-slot-ping-value: 1000
layouts:
default:
fixed-slots:
- '1|&cRAM&f:'
- '2|&b%memory-used%MB / %memory-max%MB'
- '3|&8&m '
- '4|&cTPS&f:'
- '5|&b%tps%'
- '6|&8&m '
- '7|&cPing&f:'
- '8|&b%ping%'
- '9|&8&m '
- '21|&c Owners'
- '25|&3 Admins'
- '31|&2 Staff'
- '41|&6 VIP'
- '61|&7 Players'
groups:
owner:
condition: permission:tab.group.owner
slots:
- '23-25'
admin:
condition: permission:tab.group.admin
slots:
- '27-30'
staff:
condition: permission:tab.group.staff
slots:
- '33-40'
vip:
condition: permission:tab.group.vip
slots:
- '43-60'
players:
slots:
- '63-80'