Servers¶
The servers configuration file, config/servers.js.
This file should export an object of server objects:
{
'Server Name': {
host?: String,
leftstatus?: String,
pterodactyl_id: String,
jar: {
type: String,
version: String
},
max_players: Number,
plugins: String[]
},
}
Server properties¶
host
host¶
Conditionally optional
Type: String
One of host or left4status is required.
The address of this server to be queried for the player count, such as mc.left4craft.org or mc.left4craft.org:25565.
left4status
left4status¶
Conditionally optional
Type: String
One of host or left4status is required.
The ID of the server in the response to be returned from Left4Status. If you set this option, you must also set left4status in config.js.
This option can be used if your internal servers can not be queried externally.
pterodactyl_id
pterodactyl_id¶
Type: String
The (short) ID of the Pterodactyl server. Used for interfacing with the Pterodactyl API when uploading files.
jar
jar¶
Type: Object
An object describing the server jar.
type
type¶
Type: String
The server type, such as paper, spigot, and bungeecord. Must be a supported server type from the API you chose for server_jars_api in config.js.
version
version¶
Type: String
The server version, such as 1.16, or for serverjars - 1.16.4 and latest.
max_players
max_players¶
Type: Number
The maximum number of players that can be online for an update to be deemed nonintrusive.
plugins
plugins¶
Type: Array
An array of plugin names that this server uses. Plugin names must match those set in plugins.js exactly. The names are case-sensitive.