Command: "group"
This article describes the use of the "group" command.
Create a group
group create <Name> <RAM> <Static> <Copy Global> <minimum Servers> <Wrapper ID>
| Placeholder | Description | Expected value |
| <Name> | Name of the server group (for example LOBBY, BEDWARS, etc.) | String (A-Z, a-z, 0-9) No special characters or spaces! |
| <RAM> | Memory in MB per server in this group | Integer (1-2147483647) |
| <Static> | If "true" the server is saved and started with the same files (world, configurations, etc.) the next time it is started. Hint: This means that only one server of this group can be connected at a time. | Boolean (true, false) |
| <Copy Global> | Specifies whether the contents of the "global" folder should be copied. | Boolean (true, false) |
| <minimum Servers> | Only considered in conjunction with the ISS plugin. | Integer (1-2147483647) |
| <Wrapper ID> | ID of the wrapper, on which server of this group should be executed. | Integer (1-2147483647) |
Delete a group
group delete <Name>
| Placeholder | Description | Expected value |
| <Name> | Name of the server group (for example LOBBY, BEDWARS, etc.) | String (A-Z, a-z, 0-9) No special characters or spaces! |
Command: "server"
This article describes the use of the "server" command.
Start a server
group start <Group> [Map]
| placeholder | Description | Expected value |
| <Group> | Name of the server group | string (A-Z, a-z, 0-9) No special characters or spaces! |
| [Map] | Optional: Enter the name of the map which should be used | string (A-Z, a-z, 0-9) No special characters or spaces! |
Stop a server
server stop <Group>-<ID>
| placeholder | description | Expected value |
| <Group> | server group name | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <ID> | ID of the server | Integer (1-2147483647) |
Execute command on a server
server exec <Group>-<ID><Command ...>
| placeholder | description | Expected value |
| <Group> | server group name | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <ID> | ID of the server | Integer (1-2147483647) |
| <Command ...> | The command to be executed (e.g. "say Hi!") | string; Spaces are possible. |
Show server
server list <Group>
| placeholder | description | Expected value |
| <Group> | server group name | string (A-Z, a-z, 0-9) No special characters or spaces! |
Command: "proxy"
This article describes the use of the "proxy" command.
Start the proxy
proxy start
Stop the proxy
proxy stop
Execute a command on the proxy
proxy exec <Command ...>
| Placeholder | Description | Expected value |
| <Command ...> | The command to be executed (e.g. "say Hi!") | string; blanks are possible. |
Show registered servers
proxy entries
Show proxy information
proxy exec <Command ...>
Command: "wrapper"
This article describes the use of the "wrapper" command.
Add a wrapper
group create <ID> <Host>
| placeholder | Description | Expected value |
| <ID> | Name of the server group (for example LOBBY, BEDWARS, etc.) | Integer (1-2147483647) |
| <Host> | IP of the server on which the wrapper is started. Tip: If the wrapper is on the same server, type | IP address (xxx.xxx.xxx.xxx) |
Remove a wrapper
wrapper delete <ID>
| placeholder | Description | Expected value |
| <ID> | Name of the server group (for example LOBBY, BEDWARS, etc.) | Integer (1-2147483647) |
List all wrappers
wrapper list
Command: "user"
This article describes the use of the "user" command.
Create a user
user create <Username> <Password> <Permissiongroup>
| placeholder | Description | Expected value |
| <Username> | Name of the new user | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <Password> | password of the new user | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <Permissiongroup> | The permission group the user is in. | string (A-Z, a-z, 0-9) No special characters or spaces! |
Delete a user
user delete <Username>
| placeholder | Description | Expected value |
| <Username> | Name of the new user | string (A-Z, a-z, 0-9) No special characters or spaces! |
Change users group
user setgroup <Username> <Permissiongroup>
| placeholder | Description | Expected value |
| <Username> | Name of the new user | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <Permissiongroup> | The permission group the user is in. | string (A-Z, a-z, 0-9) No special characters or spaces! |
List users
user list
Command: "permissiongroup"
This article describes the use of the "permissiongroup" command.
Create group
permissiongroup create <Groupname>
| placeholder | Description | Expected value |
| <Groupname> | Name of the permission group | string (A-Z, a-z, 0-9) No special characters or spaces! |
Delete group
permissiongroup delete <Groupname> <New group for users>
| placeholder | Description | Expected value |
| <Groupname> | Name of the permission group | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <New group for users> | Name of the permission group into which users of the one to be lied are to be moved. | string (A-Z, a-z, 0-9) No special characters or spaces! |
Add a permission
permissiongroup addperm <Permissiongroup> <Permission>
| placeholder | Description | Expected value |
| <Groupname> | Name of the permission group | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <Permission> | Permission Tip: You can find all permissions here Permission Groups | string (A-Z, a-z, 0-9) No special characters or spaces! |
Remove a permission
permissiongroup removeperm <Permissiongroup> <Permission>
| placeholder | Description | Expected value |
| <Groupname> | Name of the permission group | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <Permission> | Permission Note: You can find all permissions here Permission Groups | string (A-Z, a-z, 0-9) No special characters or spaces! |
Command: "plugin"
This article describes the use of the "plugin" command.
Show plugins
plugin list
Disable plugin temporarily
plugin disable <Name>
| Placeholder | Description | Expected value |
| <Name> | name of the plugin (filename without ".jar") | string (A-Z, a-z, 0-9) No special characters or spaces! |
Load and activate plugin
plugin load <File>
| Placeholder | Description | Expected value |
| <File> | file name without ".jar" | string (A-Z, a-z, 0-9) No special characters or spaces! |
Download and activate plugin
plugin download <ID>
| Placeholder | Description | Expected value |
| <ID> | Plugin ID Tip: You can find out how to download plugins here: What is a Cloud Plugin? | string (A-Z, a-z, 0-9) No special characters or spaces! |
Update plugin
plugin update <ID>
| Placeholder | Description | Expected value |
| <ID> | Plugin ID | string (A-Z, a-z, 0-9) No special characters or spaces! |
Command: "api"
This article describes the use of the "api" command.
extract API
api extract
This command extracts the CaveCloud APIs for the proxy server and the Minecraft servers. These are stored in the cavecloud_api directory.
Command: "update"
This article describes the use of the "update" command.
Checks if an update is available
update
Installs update, if available
update install
Note: The cloud must be restarted after installing the update.
Command: "players"
This article describes the use of the "players" command.
List players
players list
Show player info
player info <playername>
| Placeholder | Description | Expected value |
| <playername> | Player's name | String (A-Z, a-z, 0-9) No special characters or spaces! |
Kick player from the network
players kick <playername> <message ...>
| placeholder | Description | Expected value |
| <playername> | player's name | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <message ...> | Kick message | string; spaces are possible. |
Move a player to another server
players move <playername> <servername>
| placeholder | Description | Expected value |
| <playername> | player's name | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <servername> | name of the server to which the player should be moved | string (A-Z, a-z, 0-9) No special characters or spaces! |
Send player a message
players tell <playername> <message ...>
| placeholder | Description | Expected value |
| <playername> | player's name | string (A-Z, a-z, 0-9) No special characters or spaces! |
| <message ...> | message | string; spaces are possible. |
Command: "end"
This article describes the use of the "end" command.
Close cloud
end
Tip: We recommend always terminating the cloud with this command, as it will gently shut down the wrappers and the cloud. Otherwise it can lead to data loss.