> For the complete documentation index, see [llms.txt](https://k0ssek-scripts.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://k0ssek-scripts.gitbook.io/docs/scripts/easter-event.md).

# Easter Event

A seasonal egg hunt with incubation, case opening, a boss rabbit and an admin panel.

**kossek\_easter** is a seasonal event for FiveM. Eggs and rabbits appear in zones around the map, players collect them, incubate the eggs by driving fast and open them in a case-opening animation. A boss rabbit shows up on a schedule for the whole server, and a trader swaps eggshells for a rare egg. Every reward is given by the server.

## Features

| Feature              | Details                                                                                                                   |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| **Egg hunt zones**   | Eggs and rabbits spawn in map zones on a cron schedule. Active zones get a blip, and players are notified.                |
| **Rabbits**          | Some spawns are rabbits that run away. Catching one gives a rare egg.                                                     |
| **Incubation**       | An egg has to be driven around above a set speed before it can be opened. Can be turned off.                              |
| **Case opening**     | A roulette animation with a weighted loot table per egg type. The prize is rolled on the server before the animation.     |
| **Boss rabbit**      | A server-wide boss with a health bar, a map blip and a marker. Every hit gives an egg, the last hit gives a bigger prize. |
| **Eggshell trader**  | An NPC that exchanges eggshells for a rare egg.                                                                           |
| **3D scoreboard**    | A board in the world with the top 10 collectors, with an in-game placement tool.                                          |
| **Admin panel**      | Live stats, manual spawns, teleports, giving eggs, player list and a loot preview.                                        |
| **Discord webhooks** | Logs for rare drops, boss kills and admin actions.                                                                        |
| **Passive drops**    | An export that lets your other scripts drop eggs.                                                                         |
| **Frameworks**       | ESX, QBCore and QBX, detected automatically.                                                                              |
| **Localization**     | Eight languages included: English, Polish, German, Czech, Spanish, French, Italian and Swedish.                           |

## Editable files

These folders are not encrypted:

* `config/` - all settings
* `bridge/` - framework and inventory integrations
* `locales/` - texts shown to players
* `__INSTALL/` - item definitions and item images

## Where to go next

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Requirements, items, start order and admin access.</td><td><a href="/docs/scripts/easter-event/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option in config/shared.lua and config/server.lua.</td><td><a href="/docs/scripts/easter-event/configuration.md">Configuration</a></td></tr><tr><td><strong>Gameplay</strong></td><td>What players do, step by step.</td><td><a href="/docs/scripts/easter-event/gameplay.md">Gameplay</a></td></tr><tr><td><strong>Admin Panel</strong></td><td>The panel, its tabs and the admin commands.</td><td><a href="/docs/scripts/easter-event/admin-panel.md">Admin Panel</a></td></tr><tr><td><strong>Loot Tables</strong></td><td>What eggs contain and how to change it.</td><td><a href="/docs/scripts/easter-event/loot-tables.md">Loot Tables</a></td></tr><tr><td><strong>Discord Webhooks</strong></td><td>Which events are logged and where.</td><td><a href="/docs/scripts/easter-event/discord-webhooks.md">Discord Webhooks</a></td></tr><tr><td><strong>Localization</strong></td><td>Choose a language, edit texts or add your own translation.</td><td><a href="/docs/scripts/easter-event/localization.md">Localization</a></td></tr><tr><td><strong>Framework Bridge</strong></td><td>Framework and inventory support, and how to adapt it.</td><td><a href="/docs/scripts/easter-event/framework-bridge.md">Framework Bridge</a></td></tr><tr><td><strong>Exports</strong></td><td>Give Easter eggs from your own scripts.</td><td><a href="/docs/scripts/easter-event/exports.md">Exports</a></td></tr></tbody></table>

{% hint style="info" %}
Need some help? Create a ticket on our [Discord](https://discord.gg/eZN5ycvPVs).
{% endhint %}