Scratch Card

Demo: https://campaigns.lucky-cycle.com/utils/games?game=scratch-card

1. Configuration

2. Options

3. Assets

Configuration

JSON

{
    "options": {
        "scratch_percentage": 60,
        "cursor_size": 1.25,
        "overlay_timeout": 60,
        "background_color": "white",
        "allow_double_click": true,
        "display_progress": false,
        "use_reward_image": false
    },
    "texts": {
      "en": {},
      "fr": {},
      "nl": {}
    },
    "images": {
      "win": {
        "en": GAME_URL + "/win_fr.png",
        "fr": GAME_URL + "/win_fr.png",
        "nl": GAME_URL + "/win_nl.png"
      },
      "lose": {
        "en": GAME_URL + "/lose_en.png",
        "fr": GAME_URL + "/lose_fr.png",
        "nl": GAME_URL + "/lose_nl.png"
      },
      "overlay": {
        "en": GAME_URL + "/overlay_en.png",
        "fr": GAME_URL + "/overlay_fr.png",
        "nl": GAME_URL + "/overlay_nl.png"
      },
      "cursor": GAME_URL + "/cursor.png",
      "brush": GAME_URL + "/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
display_progress	Boolean	Adds a progress bar at the bottom of the scratch zone.	false
use_reward_image	Boolean	Use static or dynamic visuals (based on the reward).	false

Assets

Key	Size	Explanation	Default
win	550 x 380px	Displayed after scratched in case of a win (and if no rewards images).	/win_en.png
lose	550 x 380px	Displayed after scratched in case of a lose (and if no rewards images).	/lose_en.png
overlay	550 x 380px	Visual to be scratched.	/overlay_en.png
cursor	64 x 64px	Replace the default cursor while scratching.	/cursor.png
brush	64 x 64px	Shape of the scratching. Uses the same image as cursor if none provided.	/cursor.png