DUXPLIMA Documentation

Welcome

What an egg hunt is with uxmEasterEggs, and what comes with the plugin.

uxmEasterEggs turns blocks of your map into eggs for players to find. An operator looks at a block, usually a player head, and registers it as an egg of one type. A player who clicks it finds it: they are paid, they hear and see what the type says, and their count goes up. Find enough and a milestone pays; find them all and the server hears about it.

It runs on Paper 26.2 or newer and on Folia, on Java 25. Installation has the details.

What a hunt is

PieceWhat it means
EggOne block of the map registered as an egg. The plugin does not place the block; it remembers its position
TypeWhat an egg is: its name, its head, its reward, its particle, what finding it does, and whether it can be found again. One file each in types/
FindA player clicking an egg. The first find counts; a type with a cooldown can be found again for its reward
MilestoneA number of eggs found that pays a reward, such as 5 or 25
CompletionFinding every egg on the map
RadarA hint over the hotbar that says how far the nearest unfound egg is
Idle particleA particle drawn on an egg for the players who have not found it yet
BoardThe eggs found, for all time, the month, the week and the day

Concepts explains how the parts fit.

What comes with it

AreaWhat you get
Typescommon and golden, and any you write, each with its own reward and effects (Types)
PlacingLook at a block and run one command, or pick a type from a window (Placing eggs)
ProtectionAn egg cannot be broken, burnt, blown up, moved by a piston or washed away (Eggs and finds)
RewardsPer type, per milestone and for completion, through experience, levels, Vault, VaultUnlocked, PlayerPoints, EcoBits or Treasury, and console commands (Rewards)
Radar and particlesA distance hint and idle particles, both shared tasks that cost the same however large the map (Radar and particles)
MomentsWhat progress, a milestone, completion and the radar say, show and sound like (Moments)
MenusA collection and a leaderboard for players, a list of placed eggs and a type picker for operators (Menus)
LeaderboardsOne board in four periods, for holograms and scoreboards (Placeholders)
LanguagesEnglish, Turkish, German, Spanish, French, Portuguese and Russian, per player (Languages)
DatabaseSQLite out of the box, or MySQL, MariaDB or PostgreSQL shared by a network (Database)

Where to go next

You wantPage
Get it runningInstallation
Understand types, finds and milestonesConcepts
Hide the first eggsYour first hunt
Write a type of your ownType files
Change what a find paysRewards
Put the board on a hologramPlaceholders