Updated config and readme

This commit is contained in:
J0nasL 2023-07-19 22:31:50 -04:00
parent ccacff562e
commit a6c6da8e83
2 changed files with 16 additions and 7 deletions

View file

@ -24,6 +24,8 @@ This plugin's configuration file (`config.yml`) allows for several gameplay cust
- If set to respawn, the egg can either respawn immediately, or only after the dragon is beaten again
- 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
- The egg owner is tracked with an entity tag, so you target them with the selector `@a[tag=eggOwner]` in any commands.
- Scoreboards track the amount of time each player has owned the dragon egg, and can be configured to track named entities as if those entities actually owned the egg.
## 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/`.
@ -40,3 +42,7 @@ This plugin's configuration file (`config.yml`) allows for several gameplay cust
- You can disallow players from using certain commands in this plugin. See the `plugin.yml` file for a list of permissions.
- It is safe to use the Bukkit `/reload` command while this plugin is running.
- When resetting the world, also delete the `data.yml` file.
# Reporting Bugs
Make sure you are running the latest version of this plugin and read that version's Known Issues list to make sure you aren't reporting a known issue.
To report a bug, please open a new [Issue](https://github.com/HyperSMP/EggHuntPlugin/issues) in this repository and fill out the bug report template.

View file

@ -16,13 +16,16 @@ resp_imm: false
#Whether to drop any eggs that players have in their ender chest onto the ground.
#Setting this to false will prevent the player from removing that egg from their ender chest.
drop_enderchested_egg: false
#Whether the egg is allowed to be stored in bundles and shulker boxes
#WIP
#can_package_egg: true
#Whether to apply an entity tag to the egg owner (works like `/tag <playerName> add <tagName>`)
tag_owner: true
#The name of the tag to apply (selected like: `/tell @a[tag=<tagName>] <message>`)
#Do not overlap with tag names used by other plugins.
#If changing this while the egg is claimed, remove the old tag by running `/tag <playerName> remove <oldTagName>`.
owner_tag_name: eggOwner
#The name of the tag to apply. Selected like: `/tell @a[tag=<tagName>] <message>`
#If changing this while the egg is claimed, remove the old tag by running `/tag <playerName> remove <oldTagName>`
owner_tag_name: eggOwner
#Whether to create and update scoreboards for time holding the dragon egg
#Scoreboards are updated when the egg changes ownership and when the world saves
#When editing the scores, modify the board tracking seconds. Other times are calculated based on that time
keep_score: true
#Whether entities with custom names are counted on the scoreboard instead of the owner when holding the egg
named_entities_keep_score: false