Skip to content

Status Configuration

Jump to bottom
Minecrell edited this page May 29, 2021 · 22 revisions

ServerListPlus Wiki

Clone this wiki locally

Contents: Introduction | Structure | Configuration
Descriptions | Player Hover Messages | Player Count | Outdated Version

The server status ping allows you to customize nearly all aspects of your server status ping. If you are looking for something complete, with most features used you can take a look at the Features page with a complete example.

Structure

The status configuration is divided in 2 sections:

  • Default - This section is the default section that is used if the other section isn't used.
  • Personalized - This section is used if the player had already joined the server once and therefore you can use his name (%player%) to personalize your server status ping.
  • Banned - This section is used if the player is banned on the server. On the standalone server it is assumed the player is NOT banned. (Requires ServerListPlus v3.4.5 or newer) Built-in support is provided for these ban plugins (Requires ServerListPlus v3.5.0 or newer):
    • AdvancedBan (Bungee, Spigot)
    • BanManager (Spigot)
    • BungeeBan (Bungee)
    • MaxBans (Spigot)

Additionally you can define custom Virtual Host configurations for usage together with Forced Hosts, for example. Refer to Virtual Hosts for more information.

Configuration

In each of the sections above you can customize your status features. We stay close to the protocol specification to allow the maximum of customization so the structure of this configuration may change in the future. Here is the structure, click on a part to get more information about it):

  • Description - previously also called MotD, main text in the server status ping.
  • Players - multiple options regarding the player slots:
    • Max - modify the maximum player count.
    • Hidden - hide your player slots completely.
    • Hover - display a message when a player hovers the player count.
    • Slots - custom player slot format - colorize, add something before it - a lot of things are possible.
  • Version - change the displayed version if an outdated client pings your server.
  • Favicon - use multiple server icons or display the player's head!

You can add multiple entries for almost every feature to have one randomly chosen!

Descriptions

Editing the status descriptions is probably the easiest feature in the configuration and an example is already included by default. It is pretty self-explaining:

  Description:
  - |-
    &a» A Minecraft Network.
    &7[&a&lPvP&7], [&a&lMinigames&7], and much more!

For more information on the syntax, please refer to the Configuration Usage page.

Formatting codes

You can use formatting codes for colors/formatting such as &c (red) or &l bold. See Formatting codes on the Minecraft Wiki for details.

RGB colors

Note: ServerListPlus 3.5.0 required (although it works sometimes with the alternative syntax on older versions). Until it's released you can download the development builds. Please report if you find any issues. On Bukkit with ProtocolLib installed you need at least build 501 from https://ci.dmulloy2.net/job/ProtocolLib/.

Minecraft 1.16 supports using arbitrary RGB colors in descriptions. They can also be used in ServerListPlus by using &#rrggbb, for example:

  Description:
  - |-
    &#45bf55A Minecraft &#0288d1Server.
    %gradient#ffbe00#f4511e%Now with RGB colors. Nice!%gradient%

Fallback colors

RGB colors are only supported starting with Minecraft 1.16. However, sometimes outdated clients might ping your server. By default, ServerListPlus will remove all RGB color codes for outdated client (StripRGBIfOutdated is enabled by default).

You can use this to place a classic color code (e.g. &c) immediately before RGB color codes. This classic color code is then used for outdated clients, e.g.:

  Description:
  - |-
    &a&#45bf55A Minecraft &#0288d1Server.
    &e%gradient#ffbe00#f4511e%Now with RGB colors. Nice!%gradient%

This will look exactly as above on Minecraft 1.16, but instead of having no colors on older Minecraft versions, there are now fallback colors:

Gradients

This is particularly useful to create color gradients (like for second line above). The %gradient...% placeholder helps to create them. It is used with two or more colors appended to the %gradient as you can see in the example above. It always ends with %gradient% after the text. You can also use other placeholders inside it, e.g.:

  Description:
  - |-
    %gradient#ffbe00#f4511e%Now with RGB colors. Hello %player%!%gradient%
    %gradient#45bf55#00abd8#45bf55%|||||||||||||||||||||||||||||||| %online%/%max% ||||||||||||||||||||||||||||||||%gradient%

Formatting

Gradients can be made bold, italic, underline, strikethrough, or obfuscated using Formatting Codes. However, note that formatting codes can only be used at the very beginning of a gradient at the moment. It is not possible to make only a part of the gradient bold.

  Description:
  - |-
    %gradient#F0C755#94090D#F0C755%&l&m&n&o&k|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||%gradient%
    %gradient#45BF55#2A4858#45BF55%&l&m&n&o&k|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||%gradient%

This has all formattings combined. Try it, it looks kinds of fun (animated on the client):

Alternative syntax

Spigot/BungeeCord primarily support RGB colors using an alternative syntax: &#rrggbb becomes &x&r&r&g&g&b&b. ServerListPlus handles translation from the easier readable &#rrggbb automatically, but you can also use the alternative syntax if you want.

  Description:
  - |-
    &x&4&5&b&f&5&5A Minecraft Server.
    &x&0&2&8&8&d&1Now with RGB colors. &x&f&f&b&e&0&0N&x&f&f&a&5&0&0i&x&f&e&8&a&0&0c&x&f&a&6&f&1&0e&x&f&4&5&1&1&e!

WARNING: Prolonged exposure to over-complicated color codes like &x&r&r&g&g&b&b may cause serious eye and brain damage. You have been warned!

Player Hover Messages

The player hover message is displayed if you hover the player count in the server list of the client. It is implemented by using the container where player names currently playing on the server are normally displayed. Because of that, it might be possible that some server lists display that wrong. Here is an example:

As you can see in the screenshot, one downside of using the player list is that at the bottom the client will add a note like ... and 125 more .... There is no way to prevent such messages, you can only try to embed them a little bit like I tried in the example above.

    Hover:
    - |-
      &aWelcome to &lA Minecraft Network&a!
      
        - &aHub: &e%online@hub%/250 players online
        - &aMinigames: &e%online@games%/500 players online
        - &aPvP: &e%online@pvp%/250 players online
      
      &aJoin now and play together with %random_player% ...

For more information on the syntax, please refer to the Configuration Usage page.

Player Count

You can also modify the maximum player count with the plugin. It allows to configure multiple randomly chosen maximum player counts, or even ranges are possible. They're also easy to configure:

  Players:
    Max:
    - 1000
    - 2000
    - 3000
    # Ranges are also possible
    # A number from 1000 to 10000
    - 1000..10000

Outdated Version

Until ServerListPlus v3.3 this is not compatible with the custom player slot format. Please update to the latest version to make both features compatible.

If an outdated client pings your server then normally your currently running Minecraft version will be displayed. In current Bukkit/Spigot builds this will also expose the running server implementation. You can customize the version name, for example to use a message telling them to download the newer Minecraft version.

  Version:
    Name:
    - '&aPlease download &lMinecraft 1.8&a!'