diff --git a/README.md b/README.md new file mode 100644 index 0000000..a588bee --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Essentia + +___ +Plugin designed for [Altitude](https://github.com/Altitude-Devs). + +This plugin aims to offer essential server features without all the bloat that comes from big name essential plugins. + +## **Downloads** +Downloads can be obtained on [Jenkins](https://jenkins.destro.xyz). + +## **Building** + +#### Initial setup +Clone the repo using `git clone https://github.com/Altitude-Devs/Essentia`. + +#### Compiling +Use the command `./gradlew build --stacktrace` in the project root directory. +The compiled jar will be placed in directory `/build/libs/`. + +#### Contributing + + +## **Commands** + +| Command | Description | Permission | +|---------------------|------------------------------------------------------------|--------------------------------------| +| essentia | Command used to reload plugin configuration. | essentia.command.essentia-reload | +| teleportrequest | Request to teleport to another player. | essentia.command.teleportrequest | +| teleportrequesthere | Request another player to teleport to you. | essentia.command.teleportrequesthere | +| teleporttoggle | Toggle teleport requests on/off. | essentia.command.teleporttoggle | +| teleportaccept | Accept teleport request. | essentia.command.teleportaccept | +| teleportdeny | Decline teleport request. | essentia.command.teleportdeny | +| clearinventory | Clears your inventory. | essentia.command.clearinventory | +| home | Teleports the your home location. | essentia.command.home | +| homes | List your homes. | essentia.command.homes | +| sethome | Set your home location. | essentia.command.sethome | +| deletehome | Deletes a home. | essentia.command.deletehome | +| back | Teleport to your last location. | essentia.command.back | +| deathback | Teleport to your last death location. | essentia.command.deathback | +| fly | Toggles creative flymode for yourself or another player. | essentia.command.fly | +| gamemode | Set gamemode for yourself or another player. | essentia.command.gamemode | +| heal | Heals yourself or another player. | essentia.command.heal | +| feed | Refill hunger and saturation of yourself or another player | essentia.command.feed | +| enchant | Enchants the item in hand. | essentia.command.enchant | +| spawn | Teleport yourself or another player to spawn. | essentia.command.spawn | + + +## **Permissions** + +| Permission | Description | +|--------------------|----------------------------------------------------------| + +## **Configuration** + +```yaml +# Magic value used to determine auto configuration updates, do not change this value +config-version: 1 +``` + +## **Support** + +## **License** +[LICENSE](LICENSE) \ No newline at end of file