Profiles - Andre601/AdvancedServerList Wiki

About

AdvancedServerList allows you to create multiple "profiles".
A Profile is simply a YAML file that contains a priority, conditions, motd, player list and/or player count.

With the exception of priority are all other settings optional, tho at least one of motd, players or playerCount needs to be set to have a valid profile configuration.

Options


Formatting

The following information can be applied to all text options available, with the exception of conditions not supporting MiniMessage formatting.

MiniMessage

AdvancedServerList uses MiniMessage from Kyori Adventure to format text.
While the MOTD option supports more advanced formatting such as HEX colours, gradients and translatable lines, are only basic color and formatting codes such as <red> or <bold> supported for players and playerCount.

The following MiniMessage features are NOT supported for any kind of config option:

  • Hover Actions (Show text, show item, etc.)
  • Click Actions (Execute command, suggest command, etc.)
  • Custom Fonts (May work, but would require an already active resource pack with the font)

Also, remember that features such as HEX colours only work on a 1.16+ server/proxy and will be downsampled to normal colors on older versions by the Adventure library.

Placeholders

AdvancedServerList supports a placeholder pattern adopted from BungeeTabListPlus, meaning the general format is ${<target> <identifier>}.
Placeholders can be used in all options except for Priority.

Please make sure to read the Notes about possible limitations.

Placeholder Notes Platforms
${players online} Displays the current amount of players online. All
${players max} Displays the total amount of players that can join. All
${player name} Displays the player's name. Player needs to join at least once before. All
${player protocol} Displays the player's protocol version (i.e. 759 for 1.19). All
${player version} Displays the player's MC version such as MC 1.19. Velocity
Any PlaceholderAPI placeholder You have to use the %identifier_options% format from PlaceholderAPI. Spigot/PaperMC

If you have an idea for another placeholder, let me know and I may add it if it is doable.


Priority

Type: Integer
Required: Yes

Sets the priority for this profile. When checking available profiles will AdvancedServerList go through each in order of priority, starting with the highest number.
It will go through each file until it finds one that has conditions returning true (Default when no conditions are set).

This means if you have a file with priority 0 and a condition that checks if a player uses 758 (MC 1.18) or older and another file with priority 1 and no condition will AdvancedServerList use the second file, even when the said player uses MC 1.18.

Conditions

Type: String List
Required: No

Allows you to define a collection of conditions that need to be met in order to have the profile displayed.
This setting works best with a higher priority to make sure it is checked first before any other file.

Only when all conditions return true will the profile be shown.

Operants

The following operands are supported:

Operant Description
< Checks if X is less than Y. In the case of non-integers will it simply compare the lengths of each string.
<= Checks if X is less than OR equal to Y. In the case of non-integers will it simply compare the lengths of each string.
> Checks if X is larger than Y. In the case of non-integers will it simply compare the lengths of each string.
>= Checks if X is larger than OR equal to Y. In the case of non-integers will it simply compare the lengths of each string.
= Checks if X and Y are equal.
!= Checks if X and Y are NOT equal.

Important!
Due to how expressions are currently parsed can you only use one operant per entry!

MOTD

Type: String List
Required: No*

Allows you to set the MOTD to display in the server list.
The plugin will only use the first two lines provided. Any extra ones will be ignored.

Remove this option or set it to motd: [] to not change the MOTD.

Basic colours such as <aqua> but also HEX colours (1.16+ only) and Gradients are supported through the MiniMessage format.

Players

Type: String List
Required: No*

Allows you to override the hover text that usually shows the players online.

Remove this option or set it to players: [] to not change the player list.

Only basic colours through the MiniMessage format (i.e. <aqua>) are supported.

PlayerCount

Type: String
Required: No*

Allows you to override the text that usually displays the current and total amount of players for the server.

Remove this option or set it to playerCount: '' to not change the player count text.

Only basic colours through the MiniMessage format (i.e. <aqua>) are supported.


*

You need to provide AT LEAST one of the three options for the profile to be valid. This means, not providing motd, players nor playerCount (Including leaving them empty) will result in the profile being considered "invalid" by the plugin.
⚠️ **GitHub.com Fallback** ⚠️