A simple server-side easter egg hunt mod for Fabric.
Download this mod along with its dependencies and put them in your server's mods folder. It should be as simple as that :)
The features of this mod were designed to be as easy to use as possible.
Placing eggs in-game requires the egghunt.place permission.
Use the /egghunt place command to obtain an Easter Egg item and start placing!
Every time an egg is placed, the item will switch to a randomly chosen texture
from the [eggPlacement] section of the configuration.
Eggs can be found by any player when they left-click or right-click on one.
The [onEggFound] section of the configuration allows you to define custom actions that are
run whenever a player finds a new egg, such as rewarding the player with a specific item.
By default, a firework is spawned.
Additionally, you can customize actions to run when a player has found all eggs in the
[onFoundAll] section of the configuration.
To remove eggs by breaking them, the egghunt.remove permission is required.
The mod will prevent eggs from being broken by any other means, such as using water or TNT.
(Note that this might cause client desynchronization issues, which can however be fixed by
relogging.)
Players can track their egg finding progress with the /egghunt progress command:
The /egghunt leaderboard command will display the current rankings of players participating
in the egg hunt:
There are two commands to reset egg data, both of which require the
egghunt.reset permission:
-
/egghunt reset player <selector>– Additionally requires theegghunt.reset.playerpermission. This command resets the progress of the selected players, allowing them to collect all previously found eggs again. -
/egghunt reset eggs– Additionally requires theegghunt.reset.eggspermission. This command removes all egg locations from the database, though the physical eggs will still persist.
This mod provides server-side translations for all its messages. If you can, please consider contributing translations in your preferred language!
When you launch your server, a configuration file will be generated at config/EggHunt.toml.
The generated file contains comments with additional information on individual settings.
Permissions can be customized using a mod like LuckPerms. If no
permissions are set, players will instead need the minimum permission level defined by the
defaultPermissionLevel setting in the configuration.