Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.
« Return to Documentation Home Page // Server List Module

Server List Module

Introduction

The Server List module allows servers to customise their server list entries, including adding a whitelist message, or a random message from a provided list.

The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.

No plugin incompatibilities have been reported.

/serverlist
Module: server-list
Provides functions for modifying the server list.

Aliases: /serverlist, /sl

Usage: /serverlist [-m|--messages <m>] [-w|--whitelist <w>]

Default Role: admin

Basic Command Permission: nucleus.serverlist.base

Permissions

  • nucleus.serverlist.base - Default Role: admin
    Allows the user to run the command /serverlist
/serverlist message
Module: server-list
Allows for temporary modification of the server list MOTD, on a timed basis.

Aliases: /serverlist message, /serverlist m

Usage: /serverlist message [-r|--remove <r>] [-l|--line <l>] [-t|--time <t>] [<messageā€¦>]

Default Role: admin

Basic Command Permission: nucleus.serverlist.message.base

Permissions

  • nucleus.serverlist.message.base - Default Role: admin
    Allows the user to run the command /serverlist message
Permission Suggested Role Description
nucleus.serverlist.base admin Allows the user to run the command /serverlist
nucleus.serverlist.message.base admin Allows the user to run the command /serverlist message
The following configuration is the default for this module:
                            # If true, the player count will not be displayed.
hide-player-count=false
# If true, any player that is vanished on the server will not appear in the online player list on the server list.
hide-vanished-players=false
# If "true", when a prospective player pings the server on the multiplayer server list, one of the messages in the list below will be sent to the player. If "whitelist", this module will only act when the whitelist is enabled.
modify-server-list-messages=FALSE
# 'Potential messages that could be sent to the player. To split over two lines, include 
where you want the line break to appear.' server-list-messages=null # 'Potential messages that could be sent to the player when the server is whitelisted. To split over two lines, include
where you want the line break to appear. # # If no entries are here, the MOTD will use the `server-list-messages` list.' whitelist-server-list-messages=[]
Search

Downloading search database, this won't take long...