Server groups
SimpleCloud needs server groups to manage different server types and deployments dynamically. The controller starts servers of every group, each one inheriting the groups properties. Server groups are made up of controller properties, which are not dynamically changeable via the API, and dynamic properties. Group properties are modifiable using the CLI and by editing the group config.
Controller properties
Controller properties are group properties, which are needed by the controller to handle the server group. They generally should not be modified by third party programs in both group and server, while the cloud is running.
| property | type | purpose |
|---|---|---|
| name | string | The name of this group |
| type | SERVER, PROXY or OTHER | The server type |
| min-memory | uint in MB (e.g. 1024) | The minimum RAM for a server of this group |
| max-memory | uint in MB (e.g. 2048) | The maximum RAM for a server of this group |
| min-online-count | uint (e.g. 1) | The minimum amount of servers constantly online of this group |
| max-online-count | uint (e.g. 2) | The maximum amount of servers constantly online of this group |
| max-players | uint (e. g. 20) | The maximum amount of players allowed in this group |
| start-port | uint (e. g. 25565) | The lowest possible port for servers of this group |
| properties | ConfigurationSection | A key value set holding the servers initial dynamic properties |
Dynamic properties
Dynamic properties are group properties, which are needed by the serverhost droplet or custom properties for your personal use. You can use custom properties in your groups configuration, and there are property Getters/Setters for servers using the API.
If you use the official Server Host Droplet, you can learn which dynamic properties are mandatory for you by going here
Examples
# A simple Survival group running on its own (no proxy connection)
name: survival
type: SERVER
min-memory: 1024
max-memory: 1024
start-port: 50000
max-players: 100
min-online-count: 1
max-online-count: 1
properties:
# These are used by the server-host droplet
configurator: "spigot_standalone" # See "configurators" page in server-host docs
template-id: "survival" # ID of the template used by the server-host
# Download link to ANY server runtime
server-url: https://api.papermc.io/v2/projects/paper/versions/1.20.4/builds/463/downloads/paper-1.20.4-463.jar
max-startup-seconds: "120" # Maximum time a server needs to start up
API reference
You can create, delete, and edit dynamic properties for groups and servers using the API.