From 03b827ab7a865ef25fe1eacb1ae9c716e5aeff60 Mon Sep 17 00:00:00 2001 From: Julian Vennen Date: Sat, 31 Jul 2021 16:29:13 +0200 Subject: [PATCH] add README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..20a53e5 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# exaroton BungeeCord Plugin +A BungeeCord plugin designed to use exaroton servers in your proxy network. +This plugin can be used on proxies that don't run on exaroton as well. + +## Setup +1. Install the plugin and start the server +2. Add the API token in the config.yml +3. Restart the proxy + +## Features + +### Start/Stop commands +Start a server and automatically add it to the network +when it goes online with `/exaroton start ` + +To stop a server and remove it use `/exaroton stop` + +The commands require the permission nodes `exaroton.start` and +`exaroton.stop` respectively. + +### Watch servers +Automatically remove offline servers specified in the bungee config +from the network and add them again when they go online. + +This can be disabled in the config. + +### Autostart +Automatically start exaroton servers defined in the plugin config +when the proxy starts and add them to the network. +This can be enabled in the config. \ No newline at end of file