Add README file
Some checks reported errors
continuous-integration/drone/push Build was killed

This commit is contained in:
Bea 2023-02-11 20:29:44 +01:00
parent b80cd4b1c9
commit 94d811bed3

30
README.md Normal file
View File

@ -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.