diff --git a/README.md b/README.md new file mode 100644 index 0000000..af10541 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# TeamserverBungee + +## Plugin setup + +1. Install this plugin on your bungee or waterfall server +2. Start the proxy server +3. Change the config to your liking and save it (no restart required) + +## Compiling +Building SteamWar.de software requires certain libraries, +which cannot be provided over traditional ways (like maven) +due to copyright issues with compiled Bungee packages. +The following libraries are required to be in the `lib` +directory exactly named like in the list: + +- `BungeeCord.jar` http://ci.md-5.net/job/BungeeCord/ +- `BungeTabListPlus.jar` https://www.spigotmc.org/resources/bungeetablistplus.313/ (3.0.0 or newer, Optional in runtime) \ No newline at end of file