Getting Started
Welcome to Easter Eggs! This plugin allows you to hide interactive, collectible eggs around your world to keep your players entertained, featuring customizable rewards, cross-server syncing, and easy setup.
Prerequisites
Section titled “Prerequisites”Before installing the plugin, ensure your server environment meets the following requirements:
- Java Version: Java 21 or newer is required.
- Server Software: Spigot, Paper, or any compatible fork (e.g., Purpur).
- Minecraft Version: 1.8 - 1.21+ (Latest versions recommended).
- Permissions Plugin Optional : A plugin like LuckPerms to manage user access.
Installation
Section titled “Installation”Setting up Easter Eggs is straightforward. Follow these simple steps to get started:
- Download the Plugin: Get the latest version of Santa Says from the official distribution page.
- Upload to Server: Place the
easter-eggs-x.x.x.jarfile into your server’splugins/directory. - Restart Server: Restart your server to generate the default configuration files.
- Verify Installation: Type
/eastereggsin-game to ensure the plugin is loaded correctly.
First-Run Configuration
Section titled “First-Run Configuration”After the first restart, a new folder will be created at /plugins/EasterEggs/. This folder contains everything you need to customize your plugin:
config.yml: Main plugin settings, storage type selection, and general behaviors.messages.yml: Full control over every string, title, and translation shown to players.mysql.yml: Configure your database credentials if you are using MySQL for cross-server synchronization.
Basic Command Structure
Section titled “Basic Command Structure”While you’ll spend most of your time in the config files, here are the essential commands:
| Command | Permission | Description |
|---|---|---|
/eastereggs <id> | eastereggs.get | Gives you the specified Easter Egg item so you can place it in the world. |
/eastereggs removeall <egg id> | eastereggs.removeall | Deletes every placed Easter Egg matching the specified ID from the server. |
/eastereggs list | eastereggs.list | Shows a complete list of all currently configured Easter Eggs and their IDs. |
/eastereggs reload | eastereggs.reload | Reloads all configurations, messages, and Easter Egg data without restarting. |
/eastereggs help | eastereggs.help | Displays a comprehensive list of all available commands and their usage. |
Next Steps
Section titled “Next Steps”Now that the plugin is installed and running, it’s time to hide some eggs:
- Creating New Eggs: Learn how to define, place, and configure your first custom Easter Egg.
- Placeholders: Hook into PlaceholderAPI to display player progress and total eggs found.
- Database Setup: Sync player data across your entire network.