diff --git a/README.md b/README.md index bd199b7..68d8b34 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Egg Hunt -**A plugin for hunting down the dragon egg and stealing it from other players.** - -**With this plugin:** +# Egg Hunt +A plugin for hunting down the dragon egg and stealing it from other players. + +##With this plugin - The dragon egg cannot be stored in an ender chest. - The egg item will drop on the ground if you leave the game with it in your inventory. @@ -12,12 +12,12 @@ - Dying with the egg, having it stolen, or losing it will change ownership accordingly. - The egg can be located/tracked regardless of whether it's a block, an item, or in an inventory, and across any dimension. -**Commands:** +##Commands - `/eggowner` - displays the name of the player who currently owns the egg - `/locateegg` - displays the current coordinates of the egg, as well as how it's being stored - `/trackegg` - points the compass in your hand towards the egg -**Customization:** +##Customization This plugin's configuration file (`config.yml`) allows for several gameplay customizations to accomodate different types of servers. - The egg can be made invulnerable, or can be set to respawn in The End when it is destroyed @@ -25,13 +25,13 @@ This plugin's configuration file (`config.yml`) allows for several gameplay cust - When the egg teleports, it can become "lost", so it will no longer have an owner until a player finds it - Dragon eggs that are already stored in a player's ender chest can be excluded from the hunt -**Installation** +##Installation - Save the provided .jar file to your server's `/plugins` directory. Alternatively, you can compile the .jar file yourself by cloning this repository to a local directory and running the maven command `mvn package`. The packaged .jar will appear in `/EggHuntPlugin/target/`. - Restart (or `/reload`) the server to generate the `/plugins/EggHunt` directory, which will contain the plugin's config file. - Open `config.yml` in any text editor to change the settings, then restart (or reload) the server to apply the changes. - If the dragon egg has already been found, update the plugin's record of the egg's location by picking up the egg item or by breaking and re-placing the egg block. -**Notes for Server Owners:** +##Notes for Server Owners: - Best paired with an anticheat to prevent duplication. (Unless you are using paperspigot, which disables falling block dupes by default) - The egg location does not update when taken out of an inventory (eg chest) until the inventory is closed, so you should also enable [inventory close](https://github.com/NoCheatPlus/Docs/wiki/%5BInventory%5D-Open) on your anticheat to prevent the player from teleporting away with their inventory open. - Only players in creative mode can move the egg into an ender chest. diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index fa9cd58..a25e059 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,5 +1,6 @@ name: EggHunt main: io.github.J0hnL0cke.egghunt.egghunt +website: https://github.com/HyperSMP/EggHuntPlugin version: 1.20.1 api-version: '1.20'