HerozDotExe/EggHuntPlugin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Reformat readme, add website url

Browse source
This commit is contained in:
J0nasL 2023-07-18 15:17:49 -04:00
parent 3aef0b6b24
commit d90208ca44
2 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,9 +1,9 @@
# Egg Hunt
**A plugin for hunting down the dragon egg and stealing it from other players.**
<img src="https://github.com/HyperSMP/EggHuntPlugin/assets/51202569/c0c860ee-bfa1-480f-baad-12874467416c" width="200" height="200"> <img src="https://github.com/HyperSMP/EggHuntPlugin/assets/51202569/c0c860ee-bfa1-480f-baad-12874467416c" width="200" height="200">
**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 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. - 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. - 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. - 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 - `/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 - `/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 - `/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. 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 - 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 - 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 - 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/`. - 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. - 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. - 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. - 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) - 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. - 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. - Only players in creative mode can move the egg into an ender chest.

1
src/main/resources/plugin.yml
View file

@ -1,5 +1,6 @@
name: EggHunt name: EggHunt
main: io.github.J0hnL0cke.egghunt.egghunt main: io.github.J0hnL0cke.egghunt.egghunt
website: https://github.com/HyperSMP/EggHuntPlugin
version: 1.20.1 version: 1.20.1
api-version: '1.20' api-version: '1.20'