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.

The platform offers a wide library of minigames beyond Scratch Cards, Spinner, Coin Drop, and Carnival Games. Every game below follows the same core pattern: assign it to an Instant Prize competition, and it becomes the interactive reveal layer customers experience after purchasing a ticket. Use the accordions below to find setup instructions and key configuration details for each game.
All minigames require the Minigame Plugin to be installed and an active Instant Prize competition. The minigame never changes the outcome — it only presents the instant prize result in an interactive way.

Fruit Slice is a slicing action game where customers swipe to cut fruit and reveal their prize. Multiple visual themes are available, making it easy to style for seasonal campaigns or brand requirements.

Available Themes

Fruit Slice supports several built-in themes you can select per competition, including:
  • Standard — the default fruit-slicing theme
  • Halloween — a spooky seasonal variant
  • Candy — a sweet, colourful style

Setting Up Fruit Slice

1

Open the competition editor

Go to your product list and click Edit on the Instant Prize competition you want to use Fruit Slice for.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Fruit Slice

Click the game selector, choose Fruit Slice, and save the competition.
4

Confirm the experience

Every ticket purchased will now give customers a go at the Fruit Slice game. The popup button appears on both the product page and the Thank You page after checkout.
Honey Shapes is a honeycomb-themed reveal game where customers tap or trace shapes to uncover their prize. Multiple visual themes are available for seasonal and branded flexibility.

Available Themes

Honey Shapes includes several themes selectable per competition. Check the Minigames widget when setting up the competition to see the current theme options available.

Setting Up Honey Shapes

1

Open the competition editor

Navigate to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to find the Minigames widget.
3

Select Honey Shapes

Choose Honey Shapes from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will give customers a go at the Honey Shapes game. The button appears on both the product page and the post-checkout Thank You page.
Bubble Pop is a satisfying reveal game where customers pop bubbles to discover their prize. Multiple themes are included, allowing you to adapt the look for different competitions and seasonal campaigns.

Available Themes

Bubble Pop ships with several built-in themes. Select the theme in the Minigames widget when configuring the competition to preview available options.

Setting Up Bubble Pop

1

Open the competition editor

Go to your product list and click Edit on the target Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Bubble Pop

Choose Bubble Pop from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will give customers a go at Bubble Pop. The popup button appears on the product page and on the post-checkout Thank You page.
Penalty Shootout is a football-themed reveal game where customers take a penalty kick to find out if they’ve won. It’s ideal for sports-themed competitions and football prize draws.

Setting Up Penalty Shootout

1

Open the competition editor

Navigate to your product list and click Edit on the Instant Prize competition you want to use.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Penalty Shootout

Choose Penalty Shootout from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will give customers a penalty kick. The popup button will appear on the product page and on the Thank You page after checkout.
Safe Cracker is an automated reveal game designed for high-volume, low-price competitions. It cycles through all of a customer’s ticket numbers in one go — no individual interaction required per ticket. Winning tickets unlock the safe and are highlighted in green.

How Safe Cracker Works

Safe Cracker runs through all of the customer’s numbers automatically. Any winning tickets cause the safe to unlock and appear highlighted in green. This makes it fast-paced and particularly well-suited to penny ticket competitions where a customer may hold many tickets.

Setting Up Safe Cracker

1

Open the competition editor

Go to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to find the Minigames widget.
3

Select Safe Cracker

Choose Safe Cracker from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will be processed through the Safe Cracker game. The popup is accessible from both the product page and the post-checkout Thank You page.
Safe Cracker is particularly effective for competitions with many tickets at a low price point, where customers expect a fast bulk reveal rather than individual interactions per ticket.
Doors/Tiles is a choice-based reveal game. Customers tap a door or tile to reveal whether their ticket has won. Each door corresponds to one ticket number. The game supports multiple visual themes including Portals, Colour Doors, and Vault.

How Doors / Tiles Works

Each door or tile on screen corresponds to one of the customer’s ticket numbers. When the customer taps a door, it opens to reveal the result for that ticket.If a customer holds more tickets than there are doors available, the doors automatically reset once all are opened — allowing the customer to continue selecting until every ticket has been revealed.

Available Variants

  • Portals — a sci-fi portal door aesthetic
  • Colour Doors — brightly coloured door panels
  • Vault — a heavy bank-vault style door

Setting Up Doors / Tiles

1

Open the competition editor

Navigate to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select a Doors / Tiles variant

Choose any Doors/Tiles variant from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will give customers a door or tile to open. The popup button appears on both the product page and the Thank You page.
Balloon Pop is a fun reveal game where customers pop a balloon to find out if they’ve won. If a customer holds multiple tickets, the balloons pop automatically in sequence — no repeated interaction needed.

Automatic Multi-Ticket Mode

When a customer purchases more than one ticket on a Balloon Pop competition, the game automatically pops all their balloons in sequence. This keeps the experience smooth and exciting even for customers with large ticket bundles.

Setting Up Balloon Pop

1

Open the competition editor

Go to your product list and click Edit on the target Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Balloon Pop

Choose Balloon Pop from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will give the customer a balloon to pop. The popup button appears on the product page and on the post-checkout Thank You page.
Packs is a collectible-style reveal game where customers open a pack to discover their prize — similar in feel to opening a trading card pack. It works with any Instant Prize competition and requires no additional configuration beyond selecting the game.

Setting Up Packs

1

Open the competition editor

Go to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Packs

Choose Packs from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will give the customer a pack to open. The popup button appears on both the product page and the Thank You page after checkout.
Cast & Cash is a fast-paced fishing game. Customers drag to cast their line or tap a fish in the water to try to catch it. Each ticket gives one cast — winning tickets catch a fish, while losing tickets pull up junk.

How Cast & Cash Works

Players can interact with the game in two ways:
  • Drag to cast — swipe to fling the line across the water.
  • Tap a fish — tap directly on a fish in the sea to target it.
The outcome is determined by the underlying instant prize. A winning ticket results in a catch; a losing ticket reels in rubbish.

Setting Up Cast & Cash

1

Open the competition editor

Navigate to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Cast & Cash

Choose Cast & Cash from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased gives the customer one cast. The popup button appears on the product page and on the Thank You page post-checkout.
Magic Ball is a simple, tactile minigame. Customers either shake their phone or tap the on-screen magic ball to find out if they’ve won. It’s accessible on both mobile and desktop.

How Magic Ball Works

  • On mobile — customers shake their device to reveal the result.
  • On desktop — customers click/tap the magic ball directly.
The result is always determined by the instant prize outcome tied to the ticket.

Setting Up Magic Ball

1

Open the competition editor

Go to your product list and click Edit on the target Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Magic Ball

Choose Magic Ball from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will give customers a Magic Ball reveal. The popup button appears on the product page and on the post-checkout Thank You page.
Piñata is a celebration-themed reveal game where customers hit a piñata to discover their prize. It suits party-themed competitions, gift-based prizes, and occasions like birthdays or seasonal events.

Setting Up Piñata

1

Open the competition editor

Navigate to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to find the Minigames widget.
3

Select Piñata

Choose Piñata from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased gives customers a piñata to hit. The popup button appears on the product page and on the Thank You page after checkout.
Snap is a card-matching game where customers match pairs to reveal their prize. The game inherits images directly from the instant prize configuration, or falls back to displaying text labels if no images are set.

Image Configuration

Snap pulls images from the instant prize entries you have set up on the competition. If an instant prize has an image assigned, that image will appear on the snap cards. If no images are configured, the game will display text only.
Do not use the same or very similar images, or instant prize names, within the same competition. Duplicate visuals will make it impossible for customers to distinguish between cards and will break the game’s matching logic.

Setting Up Snap

1

Open the competition editor

Go to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Snap

Choose Snap from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased will give the customer a game of Snap. The popup button appears on both the product page and the post-checkout Thank You page.
Snap can be configured with unique custom images or with text labels — use whichever presentation works best for your prize lineup.
Darts is a fast-paced game where customers throw darts at a dartboard. Hitting a bullseye means the ticket has won. The game includes powerups that add excitement for high-volume ticket competitions.

How Darts Works

Customers throw darts at the board. Each ticket purchased gives them one dart. Powerups are available during play:
  • R3 — shoots 3 darts at once
  • x5 — a 5-dart multishot
  • Special — an additional powerup throw
When a customer hits a bullseye (a winning ticket), their powerups reset and the win is confirmed. This cycle of throws and powerup resets makes Darts ideal for penny-priced, high-volume competitions where customers hold many tickets.
If a customer has too many darts to throw individually, they can click All Out to process the remaining darts automatically.

Setting Up Darts

1

Open the competition editor

Navigate to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Darts

Choose Darts from the game selector and save the competition.
4

Confirm the experience

Every ticket purchased gives the customer one dart. The popup button appears on both the product page and the Thank You page after checkout.
Slot Machine is a classic reels game. Customers pull the lever (or tap to spin) and watch the reels to find out if they’ve won. The game automatically inherits your website’s brand colours and pulls images from the instant prize configuration.

Image Configuration

The Slot Machine uses images from the instant prize entries tied to the competition. If no images are set, the reels will display text labels instead.
Do not use the same or very similar images or instant prize names in the same competition. Duplicate entries will make the slot reels indistinguishable and may cause unexpected behaviour.

Setting Up the Slot Machine

1

Open the competition editor

Go to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Slot Machine

Choose Slot Machine from the game selector and save the competition.
4

Test the game on your website

After saving, test the Slot Machine on your live website to confirm it is working correctly before promoting the competition to customers.
Always test the Slot Machine on your own website after enabling it to verify the functionality is working as expected.
The Slot Machine automatically adopts your website’s brand colours — no manual colour configuration is required unless you want to override the defaults.
Mystery Boxes is a straightforward reveal game where each ticket gives the customer a box to open. The suspense of not knowing what’s inside until the box opens makes it broadly appealing across all competition types.

Setting Up Mystery Boxes

1

Open the competition editor

Navigate to your product list and click Edit on the Instant Prize competition.
2

Find the Minigames widget

Scroll below the Featured Image to locate the Minigames widget.
3

Select Mystery Boxes

Choose Mystery Boxes from the game selector and save the competition.
4

Test on your website

After enabling, verify the Mystery Boxes game is working correctly on your website before driving traffic to the competition.
Test the Mystery Boxes functionality on your website after enabling it to confirm correct behaviour before the competition goes live.
Gem Mine is a layered instant-win system where tickets are organised into gem clusters. Hitting a standard ticket wins that ticket’s prize. Hitting the special Gem Ticket within a cluster awards all remaining instant prizes under that gem. It’s a uniquely engaging format that rewards customers for persistence and creates high-value jackpot-style moments.

How Gem Mine Works

Gem clusters (e.g. Ruby, Emerald) each contain a collection of instant win tickets. Each cluster also has one designated Gem Ticket. When a customer’s ticket number matches:
  • A standard instant win ticket — they win that individual prize as normal.
  • The Gem Ticket — they win a new order containing all the remaining unawarded instant prizes under that gem cluster.
When a Gem Ticket is hit, a new order is created and allocated to the winner. Those prizes integrate with Payouts, appear in Prize History, and trigger the usual notification emails — just like any regular instant win.

Clusters and Nesting

Gems can be clustered together. For example, a single ticket number can be the Gem Ticket for one cluster while also being an instant prize inside another cluster. Customers can hit two different Gem Tickets within the same order if they hold the right ticket numbers.

Configuration

1

Set up an Instant Prize competition

Create or open an Instant Prize competition. It can be in draft status — it does not need to be published to configure Gem Mine.
2

Assign Gem Mine in the Minigames widget

Scroll below the Featured Image to the Minigames widget and select Gem Mine. Once selected, a new gem configuration widget will appear above the Instant Prize widget.
3

Configure your gem clusters

In the gem configuration widget, assign instant prize tickets to each gem (e.g. Ruby, Emerald). Each gem cluster needs at least one ticket assigned as the Gem Ticket.
4

Add the shortcode to your description

Add the shortcode [gem_mine_prize] to the competition description. This embeds the gem boxes on the frontend product page so customers can see which gems are available and how many prizes remain.
5

Publish and test

Publish the competition and verify the gem boxes display correctly on the frontend. Confirm that winning a Gem Ticket correctly allocates remaining prizes.

Gem Mine on the Frontend

Once configured, customers will see gem boxes on the competition page. Each box shows the gem name and the current count of remaining prizes underneath it. As prizes are won, the count decreases. When a Gem Ticket is hit, all remaining prizes are crossed off and allocated to the winner.
Gem Mine can be rebranded to match different themes — for example Battleships or Football themes are available. Contact support to discuss rebranding options.
Any Gem Mine wins are displayed on the Checkout page after payment, alongside the customer’s other results.

Build docs developers (and LLMs) love