🥚EASTER EVENT

This documentation covers all configuration options you have access to. The script automatically detects your framework (ESX, QBCore, QBox) and handles all event logic automatically

1) Item Setup

Before configuring the script, you need to add all items to your server's inventory system.

⚠️ IMPORTANT: The examples below are reference only. Every inventory system has its own structure, and updates can change how items are added. You are responsible for adding items correctly to your specific inventory system.

If you're unsure how to add items to your inventory:

  • Check your inventory resource documentation

  • Consult with your server developer

ESX — SQL

-- Shop items (items players can buy with points)
INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES
('easter_choco_egg', 'Chocolate Easter Egg', 50, 0, 1),
('easter_hot_cross_bun', 'Hot Cross Bun', 100, 0, 1),
('easter_spring_basket', 'Spring Basket', 200, 0, 1),
('easter_bunny_ears', 'Bunny Ears', 50, 0, 1),
('easter_bunny_costume', 'Bunny Costume', 500, 0, 1);

-- Box rewards (items found in Easter eggs)
INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES
('easter_mini_eggs', 'Mini Chocolate Eggs', 20, 0, 1),
('easter_carrot', 'Easter Carrot', 30, 0, 1),
('easter_painted_egg', 'Painted Easter Egg', 40, 0, 1),
('easter_spring_flower', 'Spring Flower', 10, 0, 1),
('easter_crystal_egg', 'Crystal Easter Egg', 100, 0, 1);

QBCore — qb-core/shared/items.lua

ox_inventory — ox_inventory/data/items.lua

Add item images to your inventory's image folder:

  • QBCore: qb-inventory/html/images/

  • ox_inventory: ox_inventory/web/images/


2) Overview

Risk Easter Event is a seasonal event system featuring:

  • 🥚 Easter egg hunt with automatic spawning

  • 🏪 Point-based shop system with exclusive rewards

  • 🎁 Random rewards from collected eggs

  • 💰 Sell system for collected items

  • ⏰ Automatic or manual egg drops

  • 🗺️ Configurable spawn zones

  • 🎯 ox_target support

  • 📊 Player statistics tracking

  • 🚗 Vehicle rewards with auto-database insertion

  • 🌐 Multi-framework support (ESX, QBCore, QBox)


3) Framework & Integration

Framework Detection

Auto-detection (recommended):

Force specific framework:

ox_target Integration

Enable ox_target:

Vehicle Spawn Location (QBCore/QBox Only)

Popular garage names:


4) Notification System

Use default notifications:

ox_lib:


5) Shop Configuration

Shop Location

With NPC (recommended for ox_target):

Popular NPC models:

Marker types:

Hide blip:


6) Shop Items Configuration

Item Types

Item reward:

Money reward:

Vehicle reward:

Rarity System

Rarity affects UI color:

  • common — White/Gray

  • rare — Blue

  • epic — Purple

  • legendary — Gold/Orange

Purchase Limits

⚠️ CRITICAL: Never change the id field after the server goes live! The database tracks purchases by ID. You can freely add new items or change prices/labels.


7) Easter Egg Commands & Admin System

Manual Drop Command

Usage:

Allow everyone to use:

How to get your identifier:

  1. Join your server

  2. Open server console

  3. Type: sv_players

  4. Find your identifier (license: or steam:)

  5. Copy to admins table

Example with multiple admins:


8) Auto-Drop System

Interval-based drops (every X minutes):

Time-based drops (specific times daily):

Disable auto-drops:

📌 NOTE: Times use server time, not player time. Check your server's timezone!


9) Cleanup System

Quick cleanup (5 minutes):

Long-lasting eggs (30 minutes):

Disable cleanup (eggs stay until restart):


10) Give Points Command

Usage:

Examples:

Disable command:


11) Easter Egg Spawn Settings

Popular prop models:

More/less eggs:

Loading screen:

Debug mode (show zones on map):

Adding Spawn Zones

Find coordinates in-game:

  1. Go to desired location

  2. Type /getcoords or use menu

  3. Add to zones table

Example zones:

💡 TIP: Larger radius = more spread out eggs. Smaller radius = eggs closer together.


12) Box Rewards (What Players Find)

How it works:

  • Each opened egg gives 1 random reward from this list

  • Amount is random between min and max

  • Total points = points * amount given

Examples:

Common reward (many items, low points):

Rare reward (few items, high points):

Balanced reward:


13) Sell Shop Configuration

Money types:

Cash:

Bank:

Black money:

Custom item (e.g., crypto):

Disable sell shop:


14) Text Localization

German translation:


15) Complete Configuration Examples

Example 1: Casual Server (Easy Mode)

Example 2: Serious RP Server

Example 3: Event Server (High Activity)


16) Troubleshooting

❌ Shop doesn't open

Cause: Too far from location or wrong framework Solution:

  • Stand directly on the marker

  • Check RISK.Framework = "auto"

  • If using ox_target, verify RISK.OxTarget.enabled = true

❌ No eggs spawn after command

Possible causes:

  • No zones configured

  • Wrong admin identifiers

Solution:

  • Add zones to RISK.Box.zones

  • Verify your identifier in Config.Easter.command.admins

  • Check server console for errors

❌ Vehicle not appearing in garage

Cause: Wrong garage name (QBCore/QBox) Solution:

  • Check RISK.DefaultGarage = "pillboxgarage"

  • Use your server's garage names

❌ Items not working

Cause: Items not added to inventory Solution:

  • Follow Section 1 for your inventory system

  • Restart inventory resource

  • Verify item names match exactly

❌ Points not updating

Cause: Database not created Solution:

  • Script auto-creates tables on first start

  • Restart the resource once

  • Check server console for MySQL errors

❌ Auto-drop not working

Cause: Wrong server time or disabled Solution:

  • Check Config.Easter.autoDrop.enabled = true

  • Verify times match your server's timezone

  • Use interval mode instead: useInterval = true


17) Best Practices

Test with /egghunt first — Before enabling auto-drops ✅ Balance points and prices — Make rewards achievable but not too easy ✅ Use multiple spawn zones — Spread eggs across the map ✅ Set reasonable cleanup times — 15-30 minutes recommended ✅ Limit exclusive items — Use uniquePerPlayer for vehicles/expensive items ✅ Add item images — Matching the item names in config ✅ Enable cleanup — Prevents server lag from old eggs ✅ Use ox_target with NPCs — Better UX than markers ✅ Adjust egg count — More eggs = easier to find ✅ Monitor auto-drop times — Check server timezone!


18) Quick Start Checklist

  • [ ] Add all items to your inventory system (Section 1)

  • [ ] Add item images to inventory image folder

  • [ ] Configure shop location RISK.Shop.coords

  • [ ] Add admin identifiers to Config.Easter.command.admins

  • [ ] Configure spawn zones in RISK.Box.zones

  • [ ] Set egg count in RISK.Box.count

  • [ ] Configure shop items and prices

  • [ ] Configure box rewards

  • [ ] Set auto-drop times or interval

  • [ ] Enable cleanup system

  • [ ] Test with /egghunt command

  • [ ] Verify points and shop work correctly

  • [ ] Check vehicle spawns (if using vehicle rewards)


Version: 1.0 Framework Support: ESX, QBCore, QBox (auto-detected) Dependencies: oxmysql (required) Optional: ox_target, risk-notify, risk-hudv2

Last updated