Easter Eggs Documentation

Easter Eggs 🥚

The complete guide to the Easter Eggs plugin. Learn how to install, configure, and master every feature to keep your players entertained by adding cool, interactive Easter Eggs to your server.

What’s New in 2.4.0

Added support for Paper 26.3.
Fixed custom egg textures failing to load on Paper 26.3, including heads in the management menu.
Fixed shutdown errors when plugin initialization is interrupted.

Existing configuration files and player data can be kept when updating. Stop your server, replace the plugin JAR with easter-eggs-2.4.0.jar, and start it again. Use the Java version required by your server; Paper 26.3 requires Java 25 or newer.

Get Started

Getting Started A step-by-step guide to installing the plugin and creating your first Easter Egg.

Creating New Eggs Learn how to define, configure, and place custom Easter Eggs in your world.

Commands

Admin Commands Administrative commands for managing eggs, player data, and plugin settings.

Configuration Files

Easter Eggs offers extensive configuration, allowing you to customize messages, database storage, and plugin behavior.

config.yml Main configuration file controlling core gameplay behavior and plugin settings.

mysql.yml Guide on setting up MySQL for data storage and cross-server synchronization.

messages.yml Customize all in-game messages, titles, subtitles, and text outputs used by Easter Eggs.

Other Files Automatically managed internal files used by the Easter Eggs plugin.

Placeholders

Easter Eggs provides built-in placeholders and full PlaceholderAPI support, allowing you to display egg hunt progress and player data across your server.

General Placeholders Placeholders for egg discovery states and player-related data.

Leaderboard Placeholders Placeholders specifically designed to display leaderboard rankings and statistics.

Developer API

Integrate the plugin with your code, listen for custom events, and manage player data through our API.

Player Events Documentation for events related to player actions and statistics.

Easter Egg Events Events triggered by discovering, interacting with, and managing Easter Eggs.

Miscellaneous

FAQ Answers to frequently asked questions and troubleshooting common issues.

Source Access Connect your accounts and access eligible private repositories through the Plugin Hub.