Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

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

Open the Box

Prev Next

An overview of the Open the Box game and the game campaign setup process.

Game Overview

Open the Box is a game in which a player makes a single selection, for example, opening a box or picking a card. A short animation then plays, and the player either wins a prize or doesn't. Whether they win depends on the customer segment they belong to and the weight you've set for each prize. For more information, see Prizes in Open the Box below.

This game is highly customizable and doesn't need to involve boxes at all. It can be reskinned into different experiences, from opening a box to picking a card or a horse race.

There are three templates you can select from:

  • Open the Box: Players choose from three gift boxes to reveal their prize.

  • Pirate's Plunder: Players choose from three treasure chests to reveal their prize.

  • Card Opener: A sports-themed variant set in a stadium. Players open a card to reveal their prize.

You're not limited to these three built-in templates. Xtremepush also provides ready-made asset packs that reskin the game with different visuals and animations, which you can upload and apply to your campaign. For example:

  • Derby Dash: A horse-racing asset pack. Players pick one of six horses, watch a race animation, and the winning horse determines their prize.

Regardless of which template you use, the likelihood of a player winning a prize is determined by the prize weight and the customer segment they belong to. For more information, see Prizes in Open the Box below.

The entire game is built and managed within the Xtremepush platform and then embedded directly on your website for your users to play.

Prerequisites

  • User Segments: To target your game to specific players, you'll need pre-configured segments. These must be created on the Xtremepush platform before you start. For more information, see Before You Create a Game Campaign.

  • Game Assets: Have your game assets prepared. These include images for the game background, the tiles for the grid, prizes, and other branded elements. Assets are uploaded directly within the game in the Assets tab when you select a template during the campaign configuration.

Game Setup

The following sections provide a high-level overview of the steps required to set up a Open the Box game.

The infographic below highlights the four key stages of the game launch workflow, from creation to monitoring:

Create Campaign

Define the rules of your new game.

✏️

🎨

Configure Mechanics

Configure prizes and optional time slots.

Customise Design

Replace assets and update texts.

⚙️

🚀

Launch & Monitor

Embed your game and view player activity.

Create Game Campaign

The first step in creating your game is creating a game campaign. A campaign acts as the container for your game, allowing you to define crucial aspects like target audiences, campaign duration and more. It also contains your game’s design, text, and prize configurations.

For more information on the required fields when setting up campaigns, see Create a Game Campaign

Selecting a template automatically loads a complete layout file and the necessary assets into your campaign's Assets tab. This streamlines configuration, allowing you to easily replace the default assets with your own without needing to build the game's layout from scratch.

Customise Game Design

After creating the campaign, the next step is to customize the game's visual design and text to match your brand. This involves three key areas:

  • Replace or Add Assets : The template you select provides a standard asset pack, which includes default images for the background, game board, and prizes. You have two options for customization:

    • You can replace any of the default assets with your own branded versions. For more information, see Replace Assets.

    • You can also add new assets that are not part of the standard pack. For more information on adding new assets, see Manage Assets.
      For a general overview on game assets, see Assets Overview

  • Update Game Texts: In the Texts tab, you can update all the standard text that appears in your game's interface. However, the text displayed when a player wins or loses is configured separately in the Prizes tab. For more information, see Update Texts

  • Make Design Changes in the Editor: For granular control over the game's front-end appearance, use the Editor. It allows you to make detailed visual adjustments, such as resizing or repositioning elements, modifying fonts and colours, or adding new components. For more information, see the following pages:

Configure Game Mechanics

Prizes in Open the Box

In the Prizes tab of your campaign, you configure the prizes available in your game. For more information on the different prize configuration fields, see Configure Prizes.

You can configure as many prizes as you like for your game. For example, a three-box game does not need to be limited to a single win prize. You could instead configure several different win prizes, each with its own weight and target segment. The example table further down this section shows what this looks like for a three-box game.

Whether a player wins a specific prize depends on:

  • Weight: Sets the likelihood of the prize being awarded relative to the other prizes in the game. A higher weight increases the chance of a player winning that prize.

  • Customer Segment: The customer segment or segments the prize is assigned to. Because prizes are tied to customer segments, a player can only win a prize that is assigned to their segment.

You must also configure a No-win prize to handle the outcome where a player does not win a prize. Assign it a weight in the same way as your win prizes to set the likelihood of this outcome.

The table below shows an example prize configuration for a three-box game with nine overall prizes:

Prize

Prize Reference

Customer Segment

Weight

🎟️ 5 Free Spins

Win

New Users, Occasional Players

15

🎟️ 10 Free Spins

Win

New Users

10

💰 €10 Bonus

Win

Occasional Players

20

💰 €10 Bonus

Win

VIP Players

30

💰 €30 Cashback

Win

VIP Players

10

🏆 €50 Cashback

Win

VIP Players

5

No-win

No-win

New Users

75

No-win

No-win

Occasional Players

65

No-win

No-win

VIP Players

55

In this example above, the winning chances for each segment are:

  • New Users: 15% chance of winning 5 Free Spins, 10% chance of winning 10 Free Spins, 75% chance of No-win.

  • Occasional Players: 15% chance of winning 5 Free Spins, 20% chance of winning the €10 Bonus, 65% chance of No-win.

  • VIP Players: 30% chance of winning the €10 Bonus, 10% chance of winning the €30 Cashback, 5% chance of winning the €50 Cashback, 55% chance of no win.

The no-win weight is different for each segment. VIP Players are the most exclusive segment, so their no-win prize has a lower weight than New Users or Occasional Players, giving them a better chance of winning a prize.

Configure Time Slots

You can control your game's daily availability by setting up specific time slots when it can be played. For example, you could make the game available only during a 'happy hour' promotion from 5 PM to 7 PM.

For more information, see Manage Time Slots (Optional).

Launch and Monitor Game

Launch Your Game

To launch your game, you must embed it on your website. For added security, you can also use a JWT token to ensure that only authenticated users are able to play.

For more information, see the following pages:

Monitor Player Activity

The Xtremepush platform automatically tracks the following engagement data for the Open the Box game, which you can view in the Games tab of your campaign:

  • A record of every player that played the game, the prize they won, and no-win outcomes.

  • Timestamps for when the user opened the game (Created At) and when they played it (Spun At).

  • Timestamps for when a prize was accepted (Accepted At) or declined (Declined At).