Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Rahat-Pagecode/gitbook-competitions/llms.txt

Use this file to discover all available pages before exploring further.

Minigames transform standard instant prize competitions into engaging, interactive experiences. Instead of a plain win/lose screen, customers interact with a themed game — scratching a card, spinning a wheel, dropping a coin, or popping a balloon — before their result is revealed. Every minigame integrates directly with your existing Instant Prize competitions and requires the Minigame Plugin to be installed on your site.
All minigames require an active Instant Prize competition to function. The outcome is always determined by the underlying instant prize — the game is a visual reveal layer, not a separate draw.

Available Minigames

Scratch Cards

Players scratch away a cover image to reveal whether they’ve won. Supports custom happy/sad reveal images, a default SVG overlay, and optional free scratch tokens per competition.

Spinner

A prize wheel customers spin after purchasing a ticket. Fully themeable per competition with customisable segment colours, border tints, and multiple visual themes including a forest variant.

Coin Drop

Players drop coins into a chute. If a customer holds multiple tickets, coins drop automatically in sequence. Supports Normal and Faster speed modes for a faster-paced reveal.

Carnival Games

Four distinct carnival-style games in one mode: Hook a Duck, Cork Pop, Catch a Frog, and Coconut Shy. Great for giving competitions a fun fairground feel.

Fruit Slice

Customers slice fruit to reveal their prize. Comes with multiple themes including a Halloween variant and a candy theme, selectable per competition.

Honey Shapes

Players tap or trace honeycomb shapes to uncover their result. Available in multiple visual themes to match seasonal or brand campaigns.

Bubble Pop

Customers pop bubbles to discover their prize. Multiple themes are available, making it easy to style for different competition types or seasonal events.

Penalty Shootout

A football penalty kick game where customers take a shot to find out if they’ve won. Ideal for sports-themed competitions and football prize draws.

Safe Cracker

Runs automatically, cycling through all of the customer’s ticket numbers in one go. Winning tickets unlock the safe and are highlighted in green — fast-paced and suited to high-volume, low-price competitions.

Doors / Tiles

Customers tap a door or tile to reveal their result. Each door corresponds to a ticket number. If a customer has more tickets than available doors, doors reset so every ticket can be revealed. Multiple visual themes available including Portals, Colour Doors, and Vault.

Balloon Pop

Players pop balloons to see if they’ve won. When a customer holds multiple tickets the balloons pop automatically in sequence, keeping the experience smooth and exciting.

Packs

Customers open collectible packs to reveal their prize — similar in feel to trading-card pack openings. Works with any instant prize competition.

Cast & Cash

A fast-paced fishing game. Players drag to cast or tap a fish in the sea. Winning tickets catch a fish; losing tickets pull up junk. Each ticket provides one cast.

Magic Ball

A simple, tactile minigame — customers shake their phone or tap the magic ball to find out if they’ve won. Works on both mobile and desktop.

Piñata

Customers hit a piñata to reveal their prize. A colourful, celebratory game mode that works well for party-themed or gift-based competitions.

Snap

A card-matching snap game. Inherits images directly from the instant prize setup. Can also be configured to show text labels instead of images. Avoid using duplicate or similar images/prize names in the same competition.

Darts

A fast-paced darts game with powerups: R3 (shoots 3 darts), x5 (5-dart multishot), and special. Hitting a bullseye means the customer won. Powerups reset on each win — perfect for high-volume penny ticket competitions.

Slot Machine

A classic slot reel game that inherits your website’s brand colours automatically. Images are pulled from the instant prize setup; falls back to text if no images are configured. Test thoroughly on your site before going live.

Mystery Boxes

Each ticket gives the customer a mystery box to open. Simple, suspenseful, and broadly appealing. Test on your website after enabling to confirm correct behaviour.

Gem Mine

A layered instant-win game where tickets are grouped under gem clusters (e.g. Ruby, Emerald). Hitting the Gem Ticket awards all remaining instants under it. Gems can be clustered together, and the shortcode [gem_mine_prize] embeds the gem boxes in your competition description. Can be rebranded as Battleships, Football, and other themes.
Additional carnival games, football games, and more are discoverable in your admin panel under Minigames → Playground. The games above represent the minigames covered in detail in this documentation.

How Minigames Work

Every minigame acts as a visual overlay on top of your Instant Prize competition. The win or loss outcome is always determined by the underlying instant prize draw — the minigame simply presents that result in an engaging way. Once a minigame is assigned to a competition:
  • A Play button appears on the competition’s product page above the Add to Cart button.
  • After checkout, the Thank You page also shows the button so customers can play immediately after purchase.
  • Customers with multiple tickets will have each ticket processed through the game in sequence.

Build docs developers (and LLMs) love