ServerConfiguration

Server configuration

This page explains the various properties of the server group configuration file.

The following table contains the configurable properties and a description for each of them:

Name	Description
name	The unique name of the server group. This property does not need to match the name of the file.
wrapper	A list of CloudNet-Wrapper IDs where servers of this server group are allowed to be launched on.
kickedForceFallback	Whether to connect players to other instances of this server group when kicked from a server of this group. Possible values: true, false.
serverType	Configures which type of server software is running on this server group. Changes behaviour in how the server's files are patched for CloudNet. Possible values: BUKKIT, GLOWSTONE, CAULDRON, CUSTOM.
groupMode	The mode this server group should be operating in. Possible values: DYNAMIC, STATIC, LOBBY, STATIC_LOBBY.
globalTemplate	The template used as a base for other templates of this server group. The name will be globaltemplate by default. Refer to the page about templates for more information on how to configure templates.
templates	A list containing all available and configured templats for this server group. Refer to the page about templates for more information on how to configure templates.
memory	The amount of memory in megabytes allocated for each server of this server group.
joinPower	The amount of join power needed for a player to connect to servers in this server group. Players can gain join power through permissions and permission group membership.
maintenance	Controls whether the server group is in maintenance mode. In this mode the behaviour regarding this group differs from non-maintenance mode in that this group is not eligible for priority startup and the maintenance copy mode in the CloudNet-Wrapper is avaiable. Possible values: true, false.
minOnlineServers	The amount of servers online at all times. CloudNet will try to keep at least this amount of servers of this server group running. Set to -1 to disable this restriction.
maxOnlineServers	The amount of servers online that shall never be surpassed. CloudNet refuses to launch additional servers of this server group once the amount of online servers has reached the configured number. Set to -1 to disable this restriction.
advancedServerConfig	This object contains options which are sometimes needed by plugins to perform their functions correctly.
advancedServerConfig. notifyPlayerUpdatesFromNoCurrentPlayer	Allows servers of this server group to receive updates about players which are currently not connected to that specific server. Possible values: true, false.
advancedServerConfig. notifyProxyUpdates	If enabled, informs the server about changes the available proxies. Possible values: true, false.
advancedServerConfig. notifyServerUpdates	If enabled, informs the server about changes the available servers. Possible values: true, false.
advancedServerConfig. disableAutoSavingForWorlds	If enabled, the server will not periodically save the loaded world to disk. This may incur a higher saving delay when copying the server to its template. Possible values: true, false.
percentForNewServerAutomatically	The percentage of players on a server of this group to cause a new server of this group to be started. This requires a server to be allowed to actually launch new servers, for example when in INGAME state. Set to 0 to disable.
priorityService	An object configuring the priority service of this server group.
priorityService.stopTimeInSeconds	A server will automatically stop, when no players has connected to it after the specified amount of time in seconds.
priorityService.global and priorityService.group	These two objects are used to automatically control the amount of servers simultaneously running depending on the amount of players on the CloudNet network or the servers of this server group.
priorityService.global.onlineServers and priorityService.group.onlineServers	The amount of servers of this server group that should be running at the given onlineCount of players. Set to 0 to disable the priority service.
priorityService.global.onlineCount and priorityService.group.onlineCount	The amount of players used as a measurement for the onlineServers property. Together these properties configure the priority startup service and determine, when new servers should be automatically started. Set to 0 to disable the priority service.
settings	An object that can be used to configure plugins that utilize the CloudNet API. Empty by default.

Priority service

The priority service is a feature built into CloudNet that enables administrators to automatically scale their Minecraft cloud to the demands by their players. Depending on the amount of players, CloudNet will automatically launch additional servers of a given server group to handle more players.

The settings in priorityService.global control this behaviour based on the amount of players on the entire CloudNet network regardless of the actual server they are on. This enables you to scale often used servers like lobby servers and hubs to keep scaled to the amount of current players.
The settings in priorityService.group only takes into account the players currently playing on the specific server group. This enables you to scale a server group on the current demand for server instances of that server group. This configuration is very useful for game servers.