Feature guide: Layout
- About
- Creating a layout
- Managing multiple layouts with conditions
- Skins
- Additional settings
- Compatibility
- Additional info
- Examples
This feature allows you to customize all 80 tablist slots. Displaying less than 4 columns is currently not supported (here's why). This feature can be enabled and configured in config.yml file under layout section.
This feature is only available for versions 1.8 and up due to massive tablist changes, which would make 1.7- compatibility require a complete rewrite of the functionality and could still cause all kinds of visual issues, including, but not limited to compatibility with other plugins adding/removing players from the tablist.
Layouts can be creating in config under layout.layouts section. A layout has 4 settings:
- Display condition (optional)
- default-skin (optional)
- Fixed slots
- Player groups
Condition that must be met for player to see the layout.
If player does not meet the condition, the next defined layout's condition is checked.
If a player does not meet any defined display condition, they will see the 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.
When configured, layout will override default-skin value and use that one for empty slots and fixed slots without skin definition. When not set, global default-skin will be displayed.
Example:
layout:
enabled: true
direction: COLUMNS
default-skin: mineskin:37e93c8e12cd426cb28fce31969e0674 # Global default skin for all layouts
enable-remaining-players-text: true
remaining-players-text: '... and %s more'
empty-slot-ping-value: 1000
layouts:
test:
default-skin: player:Notch # All empty slots will use skin of player "Notch" in this layout
fixed-slots: []
groups:
players:
slots:
- 1-80
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%'
If you do not wish to use any fixed slots, make it an empty list ([]).
Example:
layouts:
staff:
fixed-slots: []
These are groups of players that meet the specified condition. They consist of 2 parts - condition and slots.
1. Condition
The condition players must meet to be displayed in the group.
If a player doesn't meet condition for a 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 condition, they are not displayed at all.
Display condition is not required (can be used to make a "default" group with the remaining players).
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 a 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.
If you're wondering how to enable / disable heads in the tablist, see FAQ.
In slots which display a connected player, 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.
Currently, TAB supports 3 skin formats:
-
mineskin:<UUID>- takes UUID from MineSkin. You can find some pre-uploaded skins at the bottom of this page. -
player:<name>- displays skin of player with thename -
texture:<texture>- uses literal skin texture. This lets you use heads from Minecraft-Heads by taking the texture in theMinecraft-URLfield.
| 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). This does not only change the slot numbers in configuration, but will also affect the way players are being filled into player groups. |
| 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:383747683" | 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 |
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 Playerlist objective 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 Playerlist objective feature incompatible.
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 a proxy. Because of this, if you use layout, you can disable global playerlist to reduce resource usage.
Layout works by adding 80 fake players into the tablist, pushing real player entries out of view. Because of this, when using per world playerlist, the feature will only hide the real players, which are outside tablist and not visible anyway and not touch the layout entries. However, you can replicate the same effect using layout feature itself, using conditions.
Example
We are going to ignore fixed slots in the examples,
as they don't affect anything, and you can just configure them however you want.
Let's create 2 layouts, one for world world1 and one for world world2.
Each layout only displays players in that world.
layouts:
layout1:
condition: "%world%=world1"
fixed-slots: []
groups:
players:
condition: "%world%=world1"
slots:
- 1-80
layout2:
condition: "%world%=world2"
fixed-slots: []
groups:
players:
condition: "%world%=world2"
slots:
- 1-80
You can also merge multiple worlds into a group.
layouts:
layout1:
condition: "%world%=world1|%world%=world2"
fixed-slots: []
groups:
players:
condition: "%world%=world1|%world%=world2"
slots:
- 1-80
You can also replicate "ignore-effect-in-worlds" by creating a layout with condition for displaying, but not for groups.
layouts:
globalWorld:
condition: "%world%=globalWorld"
fixed-slots: []
groups:
players: # No condition here to show all players
slots:
- 1-80
From 1.19.3 until 1.21.1 (inclusive), entries will also appear in chat complete. The mechanic used to hide them on <1.19.3 can no longer be used since 1.19.3. 1.21.2 has added a new way of sorting players, which is being taken advantage of to restore empty chat complete.
Layout works by creating 80 fake entries, pushing real players out of the tablist.
Unfortunately, players must be spawned around the player viewing the tablist to see the second layer of their skin.
Since those fake entries you see are not the actual players and aren't spawned,
as a result, you won't see the second layers of skins.
This can only be fixed by actually letting the real entries display in the tablist,
which would require a rework of the feature, which is not planned.
1.21.4 has added a new tablist option called "show hats", which layout sets to true.
They will be visible for 1.21.4+ players.
Tablist entries automatically adapt their width based on the longest entry.
The final width is global for all columns, not just using the longest width in each respective column.
When the requested width is higher than the game window can handle, the text in entries will start to overlap.
This is how it looks with 1/4 screen size, which is the default window size when launching Minecraft.
This can be solved by increasing window size either manually, or by pressing the expand button on the top left, next to the "X".
If it still looks the same for you even though you have the game in full screen, your GUI scale can be messed up.
To fix it, go to Esc -> Options -> Video Settings... and set GUI Scale: to a lower value.
If you are looking for a more systematic solution that will automatically work for all of your players and not just you, the only way is to make the entries shorter. Here are a few tips how to do that:
- Avoid using suffix altogether
- Do not use bold (
&l) code - Use a shorter alternative for your prefixes, such as
Ainstead ofAdmin - Remove unnecessary brackets from prefix
layout:
enabled: true
direction: COLUMNS
default-skin: mineskin:383747683
enable-remaining-players-text: true
remaining-players-text: '... and %s more'
empty-slot-ping-value: 1000
layouts:
default:
fixed-slots:
- "1|&2&lLobby"
- "21|&2&lSurvival"
- "41|&2&lCreative"
- "61|&2&lSkyblock"
groups:
lobby:
condition: "%server%=lobby"
slots:
- 2-20
survival:
condition: "%server%=survival"
slots:
- 22-40
creative:
condition: "%server%=creative"
slots:
- 42-60
skyblock:
condition: "%server%=skyblock"
slots:
- 62-80
You can also remove the last condition (in this case condition: "%server=skyblock%") and the columns will be used for all other servers, instead of just a specified one.
