Scratch Card

Configuration

JSON
{
    "options": {
        "scratch_percentage": 60,
        "cursor_size": 1.25,
        "overlay_timeout": 60,
        "background_color": "white",
        "allow_double_click": true,
        "use_reward_image": false,
        "default_lang": "fr"
    },
    "texts": {
      "en": {},
      "fr": {},
      "nl": {}
    },
    "sounds": {},
    "images": {
      "win": {
        "en": GAME_URL + "/assets/scratch-card/win_fr.png",
        "fr": GAME_URL + "/assets/scratch-card/win_fr.png",
        "nl": GAME_URL + "/assets/scratch-card/win_nl.png"
      },
      "lose": {
        "en": GAME_URL + "/assets/scratch-card/lose_en.png",
        "fr": GAME_URL + "/assets/scratch-card/lose_fr.png",
        "nl": GAME_URL + "/assets/scratch-card/lose_nl.png"
      },
      "overlay": {
        "en": GAME_URL + "/assets/scratch-card/overlay_en.png",
        "fr": GAME_URL + "/assets/scratch-card/overlay_fr.png",
        "nl": GAME_URL + "/assets/scratch-card/overlay_nl.png"
      },
      "cursor": GAME_URL + "/assets/scratch-card/cursor.png",
      "brush": GAME_URL + "/assets/scratch-card/cursor.png",
      "rewards": {}
    }
}

Options

Key
Type
Explanation
Default
scratch_percentage

Integer

Percentage of the image to be scratched for the game to end.

60

cursor_size

Integer

Size of the cursor.

1.25

overlay_timeout

Integer

Delay before the game ending.

60

background_color

Text

Background color (behind the images).

"white"

allow_double_click

Boolean

Let people skip the scratching by double-clicking.

true

use_reward_image

Boolean

Use static or dynamic visuals (based on the reward).

false

default_lang

String

[PTF] Default language if unmatched language.

"fr"

Assets

Key
Size
Explanation
Default
win

550 x 380px

Displayed after scratched in case of a win (and if no rewards images).

lose

550 x 380px

Displayed after scratched in case of a lose (and if no rewards images).

overlay

550 x 380px

Visual to be scratched.

cursor

64 x 64px

Replace the default cursor while scratching.

brush

64 x 64px

Shape of the scratching. Use the same image as cursor if none provided.

Last updated