> ## Documentation Index
> Fetch the complete documentation index at: https://help-loyalife.xoxoday.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gamification

> Create scratch cards, spin wheels, and dice games in Loyalife to reward channel partners with vouchers and prizes.

Gamification lets admins configure reward-based games that channel partners play to win vouchers. Three game types are available: Scratch Card, Spin the Wheel, and Roll a Dice. Each game has configurable rewards and win probabilities that you define at creation time.

## Overview

Games appear to partners in the mobile app as interactive experiences. The reward a partner wins is determined by the probability weights you configure — the animation they see always reflects the actual result.

## Dashboard

The Gamification dashboard shows a summary of activity across all games in your program.

| Metric              | Description                                       |
| ------------------- | ------------------------------------------------- |
| Total Games         | Total number of games ever created                |
| Active Games        | Games currently set to Active status              |
| Total Engaged Users | Unique partners who have played at least one game |

Below the summary, the games table lists each game with the following columns:

| Column          | Description                                  |
| --------------- | -------------------------------------------- |
| Game Name       | Display name shown to partners in the app    |
| Game Type       | Scratch Card, Spin the Wheel, or Roll a Dice |
| Engaged Users   | Number of partners who have played this game |
| Vouchers Issued | Total vouchers awarded through this game     |
| Status          | Active or Inactive toggle                    |
| Actions         | Edit, delete, or view details                |

## Creating a game

<Steps>
  <Step title="Game details">
    Fill in the basic information for the game:

    | Field       | Required | Description                                                                          |
    | ----------- | -------- | ------------------------------------------------------------------------------------ |
    | Game Name   | Yes      | Display name shown to partners                                                       |
    | Description | No       | Brief explanation of the game and its rewards                                        |
    | Start Date  | Yes      | Date from which partners can play                                                    |
    | End Date    | Yes      | Date after which the game is no longer available; must be on or after the start date |
  </Step>

  <Step title="Reward configuration">
    Add one or more reward entries. Each entry represents a possible outcome when a partner plays the game.

    See the [Reward configuration fields](#reward-configuration) table below for the full list of fields per entry.
  </Step>

  <Step title="Win probability">
    Assign a percentage probability to each reward entry. The total across all entries must equal exactly 100%. The form shows a running total as you enter values and blocks submission if the total is not 100%.

    See [Win probability](#win-probability) for guidance.
  </Step>

  <Step title="Submit">
    Select **Submit**. The game is created immediately and appears in the dashboard listing. Partners can play it from the configured start date.
  </Step>
</Steps>

## Reward configuration

Each reward entry in the game has the following fields.

| Field              | Description                                             |
| ------------------ | ------------------------------------------------------- |
| Reward Type        | The type of reward (for example, Voucher)               |
| Voucher Category   | The category the voucher belongs to                     |
| Voucher            | The specific voucher to be awarded                      |
| Denomination Value | The monetary value of the voucher, in rupees            |
| Voucher Expiry     | Number of days from issuance before the voucher expires |

You can add multiple reward entries to a single game, each with a different voucher and probability.

## Win probability

Each reward entry must be assigned a probability percentage. The system enforces the following rules:

* Probabilities must be whole or decimal numbers greater than zero
* The sum of all probabilities must equal exactly **100%**
* The form displays a real-time running total as you enter values
* Submission is blocked if the total is not 100%

<Info>
  If you have three reward entries, a valid distribution might be 60%, 30%, and 10%. The partner's outcome is determined server-side using these weights — the game animation always matches the server result.
</Info>

## Game types

### Scratch Card

Partners scratch the card on their screen using a touch gesture, which progressively reveals the reward underneath. The card auto-reveals once the scratched area reaches a configurable threshold (for example, 60% of the surface). The revealed reward can be displayed as text or as an image. Partners can replay if the game allows it.

### Spin the Wheel

Partners tap to spin a wheel divided into coloured segments. Each segment represents a possible reward. The wheel spins with a smooth deceleration animation and comes to rest on the winning segment. Segment labels, colours, and reward values are driven by your reward configuration. The animation always matches the server-determined result.

### Roll a Dice

Partners tap to roll one or more dice. Each die rotates with a realistic animation before landing on a face. The final result shown matches the server-determined outcome. Multiple dice are supported, with the combined result used to determine the reward.

## Managing games

### Activating and deactivating

Use the **Status** toggle in the games table to switch a game between Active and Inactive.

| Status   | Effect                                                  |
| -------- | ------------------------------------------------------- |
| Active   | Game is visible and playable for partners in the app    |
| Inactive | Game is hidden from partners; no new plays are recorded |

<Warning>
  A game cannot be set to Active if its reward or probability configuration is invalid (for example, if the probability total does not equal 100%). Resolve any configuration issues before activating.
</Warning>

### Editing a game

Select **Edit** from the Actions menu to update the game name, description, dates, rewards, or probabilities. Changes take effect immediately for partners who have not yet played.

### Deleting a game

Select **Delete** from the Actions menu. A confirmation prompt will appear before the game is permanently removed. Deleting a game does not revoke vouchers already issued through it.

<Info>
  Creating and managing games requires the **Gamification Management** permission.
</Info>
