Frozen Christmas Lottery

Frozen Christmas Lottery for FiveM: scratch cards, a prize wheel, pick-a-present, an advent calendar and a grand draw, all set up in game with /xmasadmin.

On this page

Frozen Christmas Lottery is a Christmas market ticket booth for FiveM: scratch cards, a prize wheel, pick-a-present, an advent calendar and a live grand draw. Lotteries, prizes, odds, prices, ticket items, advent doors, the draw, kiosks, texts and the Discord webhook are all set up in game with /xmasadmin, so you never edit a config file. It runs on ESX, QBCore, Qbox, vRP, ox_core and ND_Core, or standalone with ox_inventory.

Guides

GuideWhat it explains
InstallationInstall the resource, give admins access and add the ticket items to your inventory
Lotteries & prizesCreate lotteries, set prices and ticket items, add prizes, and how the odds and RTP work
Advent calendarThe free daily doors: month, missed days and the prize behind each door
Grand drawThe raffle: ticket price, the pot, winner shares, rollover and repeating draws
Kiosks & boothPlace vendors, choose ped models and blips, and what players see in the booth
SettingsEvery option in Settings: texts, currency, effects, announcements, Discord and resets
Dashboard, tickets & logsThe statistics, prizes waiting, giving tickets and the logs
ConfigurationEvery option in config.lua, storage, admins and the exports
Common issuesFixes for the problems server owners run into most

Games

GameHow it plays
Scratch cardA printed ticket with silver frost, a serial number and the odds. Rub it off with the mouse; three of the same prize wins
Prize wheelOne segment per prize plus coal segments. One spin per ticket
Pick a presentChoose one of 3 to 9 presents, then see what the others held
Advent calendarOne free door a day in the month you choose (December by default). Each character opens each door once
Grand drawNumbered raffle tickets, a growing pot and a countdown. The winning numbers are rolled live for the whole server

Four lotteries are ready to play: Candy Cane Scratch (money_ticket), Santa's Sack (item_ticket), Frosty Wheel (wheel_ticket) and Golden Star (golden_ticket). Change them, or add your own, in /xmasadmin → Lotteries.

Commands

CommandWhoWhat it does
/xmasadminAdminsOpens the lottery office (admin menu)
/xmaslotteryEveryoneOpens the lottery from anywhere. Only works when Open from anywhere is on in Settings

Both names can be changed in config.lua (Config.AdminCommand, Config.PlayerCommand).

Admin menu

Each tab has its own guide, linked above.

TabWhat you can do
DashboardTickets played, money taken in and paid out, money removed from the economy, the draw pot and the real RTP of every lottery
LotteriesName, game, description, colour, picture, ticket item, price, payment (cash, bank or an item) and the prize table. Win chance, average prize and RTP update while you edit. Test play tries it before you save
Advent calendarTurn it on, pick the month, add or remove doors, and set a money or item prize and a rarity per door. Missed days are lost decides whether players can open earlier doors later
Grand drawTicket price, starting pot, how much of each ticket goes into the pot, max tickets per player, winner shares (for example 60, 25, 15), draw time and repeat. Draw now or Cancel round & refund
KiosksWalk somewhere and press Place at my position. Each kiosk has a name, a ped model, a Christmas tree and a map blip you can switch on or off
Give ticketsGive a player tickets for any lottery
LogsEvery ticket played, advent door opened and draw ticket bought or won
SettingsTitle and subtitle, currency symbol, odds shown to players, booth camera, animations, snow, sounds, music and volume, open from anywhere, win announcements, the live draw and the Discord webhook

Prizes

A prize can be cash, bank money, black money or any item. Item pictures come from your inventory automatically (Config.ItemImages = 'auto'). A prize can also use its own picture: a URL, a nui:// link, a file in html/img/items/ or one of the built-in icons (star, candy, sack, wheel, tree, bell, snowflake, gift, sock, deer, cookie, ornament, coal, money, bank).

Fair and safe

  • Every result is rolled on the server before the animation starts. The screen only shows it.
  • A ticket can be claimed once, a player plays one ticket at a time, and calls are rate limited.
  • A prize is never lost. If a player leaves mid-game, has a full inventory or wins the draw while offline, the prize waits and is given the next time they load in or open the lottery.
  • Admin input is checked on the server: numbers are clamped, text is cleaned and items are checked.

Making it yours

  • Art: replace the pictures in html/img/xmas/ with your own of the same name (.webp, .png or .jpg). background is behind the games, scratch_cover is the silver frost on scratch cards, and lottery_<id> is a lottery's picture (for example lottery_candy_cane.webp).
  • Sounds: replace any file in html/sounds/ with your own .ogg of the same name.
  • Texts: the title, subtitle and currency symbol are in /xmasadmin → Settings.

Exports

lua
-- ox_inventory item export (set in the item's server.export, see Installation)
exports.frozen_xmaslottery:useTicket(...)

-- Any other inventory: call this from the item's use code
exports.frozen_xmaslottery:UseTicket(source, 'money_ticket')

More in this guide

Still stuck?Ask on our Discord