TabList - montlikadani/TabList GitHub Wiki

This is the initial documentation for displaying the tablist header and footer. All settings can be found in the tablist.yml file.

Required settings

For the header and footer to appear, it is necessary to enable the enabled option for it to work at all.

enabled: true

Optional settings

It is possible to hide the header and footer for different players or for everyone. This requires running the /tl toggle command. If you want to save these hides when shutting down a server, you can enable remember-toggled-tablist-to-file, which will create a file and include the players for whom the tablist is hidden. However, if this file is empty, it will be deleted.

remember-toggled-tablist-to-file: true

It is possible to hide the header and footer when a player is in a vanish state.

hide-tab-when-player-vanished: true

It is possible to disable the tablist completely in different worlds.

disabled-worlds:
- world_the_end

The refresh time for headers and footers can be changed using the interval setting. This counts as a server tick.

interval: 4

Random display requires the random option to be enabled, which will display both headers and footers randomly, depending on the list size.

random: true

Supported syntaxes for the header and footer component

You have two options for displaying a header or footer, one of which is to treat one of the components as a simple string, or to enter rows like a list.

Examples

header: "&6Ping:&r %ping%&7ms"

footer:
- "&e&lPlayers:&6 %online-players%&7/&6%max-players%"