diff options
Diffstat (limited to 'doc/dynamic_servers.md')
| -rw-r--r-- | doc/dynamic_servers.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/dynamic_servers.md b/doc/dynamic_servers.md index 459c8da..31e5086 100644 --- a/doc/dynamic_servers.md +++ b/doc/dynamic_servers.md @@ -1,6 +1,7 @@ # Dynamic servers ## About + While servers are traditionally defined in the config plugins have the ability to add new servers at runtime. Dynamic servers can be deleted when they are no longer needed @@ -13,17 +14,23 @@ This feature can be useful to implement things like starting minigame servers as needed. ## Adding servers at runtime -A plugin may call [AddServer](https://pkg.go.dev/github.com/HimbeerserverDE/mt-multiserver-proxy#AddServer) to dynamically create a server at any time. + +A plugin may call [AddServer](https://pkg.go.dev/github.com/HimbeerserverDE/mt-multiserver-proxy#AddServer) +to dynamically create a server at any time. It returns a boolean indicating success. ### Conditions + * Server name is not taken * Media pool contains at least one static member ## Removing servers at runtime -A plugin may call [RmServer](https://pkg.go.dev/github.com/HimbeerserverDE/mt-multiserver-proxy#RmServer) to dynamically delete a dynamic server at any time. + +A plugin may call [RmServer](https://pkg.go.dev/github.com/HimbeerserverDE/mt-multiserver-proxy#RmServer) +to dynamically delete a dynamic server at any time. It returns a boolean indicating success or an already inexistent server. ### Conditions + * Server was dynamically added * No player connections |