diff --git a/README.md b/README.md index badbc92..12b6b84 100644 --- a/README.md +++ b/README.md @@ -1 +1,58 @@ -# KygekEatHeal-Spigot \ No newline at end of file + +### NOTICE: This is the Spigot version of KygekEatHeal. Please see [here](https://github.com/KygekTeam/KygekEatHeal) for PocketMine-MP version. + +# KygekEatHeal + +[![Discord](https://img.shields.io/discord/735439472992321587.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/CXtqUZv) + +A plugin that can heal and feed yourself or other players. Vault is supported for paid heals and feeds. + +# Features + +- Vault support for paid heals and feeds +- Customizeable heal or feed amount (points) +- Heal or feed another player +- Offline player detection +- Full or healthy detection (so you won't waste money!) +- Command descrption can be changed +- Supports command aliases (requires recompile and change of the plugin.yml in this version) +- Automatic configuration files reloading +- Automatic configuration file updater + +# How to Install + +1. Download the latest version (It is recommended to always download the latest version for the best experience, except you're having compatibility issues). +2. Place the `KygekEatHeal.jar` file into the `plugins` folder. +3. Restart or start your server. +4. Done! + +# Commands & Permissions + +| Command | Default Description | Permission | Default | +| --- | --- | --- | --- | +| `/eat` | Eat or feed a player | `kygekeatheal.eat` | true | +| `/keat` | Eat or feed a player | `kygekeatheal.eat` | true | +| `/feed` | Eat or feed a player | `kygekeatheal.eat` | true | +| `/kfeed` | Eat or feed a player | `kygekeatheal.eat` | true | +| `/heal` | Heal yourself or a player | `kygekeatheal.heal` | true | +| `/kheal` | Heal yourself or a player | `kygekeatheal.heal` | true | + +Permission `kygekeatheal` can be used to allow all commands (Default is `true`). + +# Upcoming Features + +- Automatic plugin update checker on server startup +- Customizeable messages + +# Additional Notes + +KygekEatHeal plugin is made by KygekTeam and licensed under **GPL-3.0**. + +- Join our Discord server here for latest updates from KygekTeam. +- If you found bugs or want to give suggestions, please visit here or join our Discord server. +- We accept all contributions! If you want to contribute please make a pull request in here. + +# Other Versions + +- [PocketMine-MP](https://github.com/KygekTeam/KygekEatHeal) +- [Nukkit](https://github.com/KygekTeam/KygekEatHeal-Nukkit)