“Scratch and win” Documentation by “All-Scripts” v1.0

---

“Scratch and win”

---

Table of Contents

1. Description
2. Getting Started
3. CSS Files
4. Filetree
5. JavaScript
6. PHP
7. Update Log

---

A) Description - top

The "Scratch and win" is a HTML5 scratchcard game.
This game has been developed in HTML5 / JavaScript and third-party library phaser - http://phaser.io/

Features:
• Audio on off
• Fullscreen
• Multilanguage can choose in the settings (English / German / Spanish)

The ZIP package contains the game with 1280 x 720 resolution that scales to fit the current screen device.
The game is fully compatible with all most common mobile devices.

---

B) Getting Started - top

To install the game just upload on your server the game folder game.

• Game Resize: All game resolution automatically center itself and fits on the screen. If you want to avoid this, you can change this in index.html file
to this (with the size you like):

• insert game in a existing page: Do you want insert the game in an existing page
And you need declare the GAME_PATH in the file "src/game.js":

                    	const GAME_PATH = 'PATH_TO_THE_GAME/';
                    

• Game option: You can easily customize game setting in php/config/config.json file.

                        {
                            "bet": 5, // price of bet
                            "decimal": 2, // decimal of credits / wins
                            "currency": "pts", // Currency where you want display
                            "wins":[
                                {"win": 2, "count": 200, "percent": 70},
                                {"win": 5, "count": 100, "percent": 60},
                                {"win": 10, "count": 55, "percent": 45},
                                {"win": 25, "count": 25, "percent": 35},
                                {"win": 40, "count": 5, "percent": 25},
                                {"win": 5000, "count": 3, "percent": 1}
                            ] // you can define custom wins here. For testing your settings copy the tools/calculator.html to the directory and call them over your browser.
                        }
                    

---

C) CSS Files - top

We using two CSS files in this Game.The first one is a generic reset file. Many browser interpret the default behavior of html elements differently. By using a general reset CSS file, we can work round this. This file also contains some general styling, such as anchor tag colors, font-sizes, etc. Keep in mind, that these values might be overridden somewhere else in the file.

The second file contains the background color of the page and maybe for future updates.

---

D) Filetree - top

• assets
  • audio
    • click.mp3
    • click.ogg
    • lose.mp3
    • lose.ogg
    • win.mp3
    • win.ogg
  • basis_high.json
  • basis_high.webp
  • bg.webp
  • loading.webp
  • mask.webp
• css
  • reset.css
  • style.css
• icon
  • app_icon_32x32.png
  • app_icon_64x64.png
  • app_icon_128x128.png
  • app_icon_256x256.png
• lib
  • phaser.min.js
• php
  • config
    • .htaccess
    • config.json
  • api.inc.php
  • game.php
• src
  • game.js
• index.html
• manifest.json

---

E) JavaScript - top

This game contains five JavaScript files.

1. Phaser v2.7.6 - lib/phaser.min.js
2. Our custom script - src/game.js

1. Phaser is an open source HTML5 game framework created by Photon Storm. It's designed to create games that will run on desktop and mobile web browsers.
2. The Game

---

F) PHP - top

This game contains 2 PHP files.

1. php/api.inc.php
2. php/game.php

1. this API works for standalone game (without creditingsystem) when you want integrate in the crediting system only need make chances in this file. Like login check, get usercredits, draw the bet, withdraw the wins ...
2. The Game (Backend - calculation and crediting)

---

G) Update log - top

12/05/2023:
- Replace jQuery and JStorage with Vanilla Javascript
- Update Pictures from png to webp

01/08/2017: The mask doesnt load when declare an invidual path.

18/08/2017: The API dont widthdraw the wins.

---

Once again, thank you so much for purchasing this game. Fell free to contact us if you have any questions or issue relating to this game. No guarantees, but we'll do our best to assist.

All-Scripts

Go To Table of Contents

---