From 94d811bed3095afdf9ca2ddd69e28d0f66ddc3bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenzo=20Dellac=C3=A0?= Date: Sat, 11 Feb 2023 20:29:44 +0100 Subject: [PATCH] Add README file --- 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..dff7982 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# HubThat + +![banner](https://i.ibb.co/KNyJTMq/hubthat-new-banner.png) +*A hub for one world, a spawn for each world!* + +## Project info + +HubThat is a Bukkit/SpigotMC plugin that allows players to manage +different spawn points in multiple worlds, and connects all +worlds together through a hub. This is useful to emulate a +small-scale network, where players can play different game modes +in different sub-servers - which in this case, are worlds. + +Spawn points can also be grouped and shared through different +worlds. Every message is configurable and the plugin also +includes features such as teleportation cool-downs (useful for +PvP) and Multiverse-Core support. + +## Configuration + +Full configuration information and setup guide can be found +on the official [SpigotMC forum thread](https://www.spigotmc.org/resources/hubthat.1166/). + +## Building from source + +- clone the git repository +- move into the cloned directory +- run `mvn clean package` + +The compiled JAR file will be located in the `/target` directory. \ No newline at end of file