Server Registration Plugin
The registration plugin updates registered proxy child servers according to the clouds registered servers. If your SimpleCloud installation uses a proxy, you need this plugin to make that proxy work correctly.
This plugin internally uses the server api to get the online cloud servers. It also provides code to make own implementations for other proxy software easy.
Supported Server Softwares
The following table shows all currently supported proxy implementations:
| Software | This Plugin | Server API |
|---|---|---|
| Velocity | Yes | Yes |
| Bungeecord | Yes | Yes |
| Gate | Planned | Yes |
| Other* | Varies | No |
*Support for other proxies is possible through custom implementation if the server API is available in your preferred programming language.
Quick Setup
- Download the plugin for your proxy software
- Place it in your proxy template's plugins folder
- Start your proxy server
- Configure the plugin using
config.yml
Configuration
The configuration file is located at config.yml in the plugin's data folder:
# Server naming pattern
server-name-pattern: "%GROUP%-%NUMERICAL_ID%"
# Available placeholder:
# %GROUP% - Group name
# %ID% - Unique server ID
# %NUMERICAL_ID% - Numerical server ID
# Ignored server groups
ignore-server-groups:
- "bedwars"
- "skywars"
# Additional non-cloud servers
additional-servers:
- name: "build"
address: "127.0.0.1"
port: 225555
Custom Implementation
The plugin provides the ServerRegisterer interface for custom implementations:
interface ServerRegisterer {
// Get all registered servers
fun getRegistered(): List<Server>
// Register new or reattached server
fun register(server: Server)
// Unregister unmounted server
fun unregister(server: Server)
}
For a complete implementation example, refer to our Velocity implementation.