“Scratch Fruit” Documentation by “Code This Lab S.r.l.” v1.0

---

“Scratch Fruit”

---

Table of Contents

1. Description
2. Folder Contents
3. Getting Started
4. HTML Structure
5. CSS Files and Structure
6. JavaScript
7. Game functions
8. Change Sprites
9. Disable Sounds
10. Wordpress Plugin

---

A) Description - top

Scratch Fruit is a HTML5 Instant Win game. Scratch the silver part to discover if you win some prizes!

The ZIP package contains the game with 1700x768 resolution that scales to fit the whole screen device
Just warning that for very wide screens, the game may not be perfectly full screen. The game is fully compatible with all most common mobile devices.
Sounds are enabled for mobile but we can't grant full audio compatibility on all mobile devices due to some well-know issue between some mobile-browser and HTML5. So if you want to avoid sound loading, please read Disable Sound section).
WARNING: Sounds can't be enabled for Windows Phone as this kind of device have unsolved issues with 'audio' and 'video' tag.

---

B) Folder Contents - top

The item package contains the following folders:

• ctl_arcade_wp_plugin:
  This folder contains the game version (zip file inside) that can be used with wordpress plugin CTL Arcade
  
  
• game:
  This folder contains the full source code that you can edit as you need.
  
  
• live_demo:
  This folder contains the obfuscated version of the game. WARNING: you should use this version if you don't have to edit the original game.
  
  
• readme:
  This folder contains the readme of the game.

---

C) Getting Started - top

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

• Game Embedding: The proper way to embed the game is in a full-screen web page or in an iframe.
  In the first case the game will fit the screen size, in the second, that of the iframe.
  If the iframe size matches that of the screen, the game will fit accordingly.
  The alignment will be proportioned to the aspect ratio of the game.
  To install the game in a WordPress website, we suggest to use our plugin CTL Arcade .
  
  
• Save Score: if you need to call your php function for saving score, you can add it in the index.html file:

  						$(document).ready(function(){
  							var oMain = new CMain();
  							
  							 $(oMain).on("save_score", function(evt,iScore) {
  								//alert("iScore: "+iScore);
  							});
  						});
  					

• Localization: You can easily change game text for different languages, changing string in CLang.js

                                    TEXT_PRELOADER_CONTINUE = "START GAME";
                                    TEXT_WIN  = "YOU WIN";
                                    TEXT_CONGRATS = "CONGRATULATIONS!";
                                    TEXT_NO_WIN    = "YOU LOST YOUR CREDITS";
                                    TEXT_PLAY      = "PLAY";
                                    TEXT_HELP1     = "SCRATCH THE SILVER SQUARES. IF YOU FIND THREE IDENTICAL SYMBOLS, YOU WIN THE PRIZE!!";
                                    TEXT_ARE_SURE = "ARE YOU SURE?";

                                    TEXT_HEAD       = "WIN TOP PRIZES!";
                                    TEXT_CURRENCY  = "$";
                                    TEXT_ADVICE_WIN = "WIN";
                                    TEXT_ADVICE_LOSE = "NO WIN";

                                    TEXT_CREDIT = "CREDIT";
                                    TEXT_PLUS = "+";
                                    TEXT_MINUS = "-";
                                    TEXT_BUYCARD = "BUY A CARD";
                                    TEXT_WIN_AMOUNT = "WIN AMOUNT";
                                    TEXT_CARD_VALUE = "BET";
                                    TEXT_PLAY_AGAIN = "PLAY AGAIN";

                                    TEXT_SHARE_IMAGE = "200x200.jpg";
                                    TEXT_SHARE_TITLE = "Congratulations!";
                                    TEXT_SHARE_MSG1 = "You collected ";
                                    TEXT_SHARE_MSG2 = " points!

Share your score with your friends!";
                                    TEXT_SHARE_SHARE1 = "My score is ";
                                    TEXT_SHARE_SHARE2 = " points! Can you do better?";
					

• Game option: You can easily customize game setting when creating a new instance of the game in index.html file

					var oMain = new CMain({
                                            fullscreen:true, //SET THIS TO FALSE IF YOU DON'T WANT TO SHOW FULLSCREEN BUTTON
                                        check_orientation:true,     //SET TO FALSE IF YOU DON'T WANT TO SHOW ORIENTATION ALERT ON MOBILE DEVICES   
                                        show_credits:true,          //SET THIS VALUE TO FALSE IF YOU DON'T WANT TO SHOW CREDITS BUTTON
                                        audio_enable_on_startup:false, //ENABLE/DISABLE AUDIO WHEN GAME STARTS 
                                        
                                        bet_to_play:[1,2,3],   //BET TO PLAY A GAME
                                        player_credit:10, //PLAYER'S CREDIT

                                        cash_credit: 1000, //TOTAL CREDIT IN CASH. PLAYER BET WILL INCREASE THE CASH, AND PLAYER WIN WILL DECREASE THE CASH. 
                                                            ///A PLAYER WILL NEVER WIN MORE THEN CURRENT CASH.

                                        //// PRIZE WIN BY THE PLAYER. THE PRIZE IS MULTIPLIED BY THE BET PLAYED
                                        prize:[ 1.00,     //PRIZE FOR COMBO 1
                                                2.50,     //PRIZE FOR COMBO 2
                                                5.00,     //PRIZE FOR COMBO 2
                                                15.00,    //PRIZE FOR COMBO 3
                                                40.00,    //PRIZE FOR COMBO 4
                                                90.00,   //PRIZE FOR COMBO 5
                                                170.00,   //PRIZE FOR COMBO 6
                                                400.00,  //PRIZE FOR COMBO 7
                                                1000.00], //PRIZE FOR COMBO 8

                                        prizeprob:[ 30,   //OCCURENCE PERCENTAGE FOR PRIZE 1
                                                    22,   //OCCURENCE PERCENTAGE FOR PRIZE 2
                                                    17,   //OCCURENCE PERCENTAGE FOR PRIZE 3
                                                    10,   //OCCURENCE PERCENTAGE FOR PRIZE 4
                                                    8,    //OCCURENCE PERCENTAGE FOR PRIZE 5
                                                    6,    //OCCURENCE PERCENTAGE FOR PRIZE 6
                                                    4,    //OCCURENCE PERCENTAGE FOR PRIZE 7
                                                    2,    //OCCURENCE PERCENTAGE FOR PRIZE 8
                                                    1],    //OCCURENCE PERCENTAGE FOR PRIZE 9

                                        win_occurrence: 30,            

                                        //winpercentage MANAGES MULTIPLE WIN OCCURENCE PERCENTAGE FOR EACH GAME
                                        multiple_win_percentage:
                                                                [
                                                                   70,  //WIN IN 1 ROW
                                                                   25,  //WIN IN 2 ROWS
                                                                   5    //WIN IN 3 ROWS
                                                           ],  

                                        scratch_tolerance_per_cell : 50, //AREA PERCENTAGE TO SCRATCH (FOR EACH SYMBOL) TO SHOW FINAL RESULT IN THE FRUIT ROW
                                        

                                        //////////////////////////////////////////////////////////////////////////////////////////
                                        ad_show_counter: 5     //NUMBER OF CARDS PLAYED BEFORE AD SHOWN
                                        //
                                        //// THIS FUNCTIONALITY IS ACTIVATED ONLY WITH CTL ARCADE PLUGIN.///////////////////////////
                                        /////////////////// YOU CAN GET IT AT: /////////////////////////////////////////////////////////
                                        // http://codecanyon.net/item/ctl-arcade-wordpress-plugin/13856421///////////
                                        
                                      });
				

---

D) HTML Structure - top

This game have the canvas tag in the body. The ready event into the body calls the main function of the game: CMain().
The head section declares all the javascript functions of the game. The whole project uses a typical object-oriented approach.
In the init function there are 6 mapped events that can be useful eventually for stats

---

E) CSS Files and Structure - top

The game use two CSS files. 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. Keep in mind, that these values might be overridden somewhere else in the file.

The second file contains all of the specific stylings for the canvas and some hack to be fully compatible with all most popular mobile devices

---

F) JavaScript - top

This game contains:

1. jQuery
2. Our custom scripts
3. CreateJs plugin
4. Howler.js plugin
5. Screenfull.js plugin

1. jQuery is a Javascript library that greatly reduces the amount of code that you must write.
2. The game have the following js files:
   • CMain: the main class called by the index file.
     This file controls the sprite_lib.js file that manages the sprite loading, the loop game and initialize the canvas with the CreateJs library
   • ctl_utils: this file manages the canvas resize and its centering
   • sprite_lib: this class loads all images declared in the main class
   • settings: general game settings
   • CLang: global string variables for language localization
   • CPreloader: simple text preloader to show resources loading progress
   • CMenu: simple menu with the play button
   • CGfxButton: this class create a standard button
   • CToggle: this class create a standard toggle button
   • CTextButton: this class create a standard text button
   • CGame: this class manages the game logic
   • CInterface: this class controls game GUI that contains text and buttons
   • CEndPanel: the final game over panel
   • CHelpPanel: the help panel that is shown before game starting
   • CRow: this class manages the fruit row that must be scratched
   • CShowResult: this class shows the WIN/NO WIN text when a row is compltely scratched
   • CVector2: this class manages the vectors useful for the math calculations
   • CAreYouSurePanel: this class ensure the confirm to exit from game
   • CCreditsPanel: this class shows the credits
3. CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.

Resuming, the complete game flow is the following:

1. The index.html file calls the CMain.js file after ready event is called
2. The main class calls CPreloader.js to init preloader text and start sprite loading
3. When all sprites contained in "/sprites" and "/sounds" folder are loaded, the main class removes the preloader and calls the CMenu.js file that shows the main menu
4. If user click the play button in main menu, the HelpPanel.js class is called and the help panel is shown
5. If user click the Play button in help screen, the CGame.js class is called and the game starts
6. The User play the game
7. When the player scratch all the 3 rows, the game calls the Game Over panel
8. If the user click on the exit button in the up-right corner, the game returns to the menu screen

---

G) Game functions - top

In this section will be explained all the most important functions used in CGame.js file.

• _init()
  This function attach on the canvas some game sprites like background (oBg), GUI and initialize the touch events..
• _initProbability()
  This function init occurence percentage of possible prizes.
• _initFruits()
  This function create the 3 randomic fruit rows.
• _scratch()
  This function is called every time mouse move event is called.
• gameOver()
  This function is called when game is over.

---

H) Change Sprites - top

The folder '/sprites' contains all the images of the game that can be replaced. Please be aware that new if you want to reskin the game graphic without any coding, your images must have the same size and file format of the old ones. The game contains also the fruit spritesheets that you must edit if you want to change fruit images.

• fruits.png: This is the fruit spritesheet.
  
  
  
  

I) Disable Sounds - top

If you want to disable all the sounds for mobile devices, you have to change the following value in settings.js file:

var DISABLE_SOUND_MOBILE = true;

J) Wordpress Plugin - top

CTL Arcade will allow you to add a real arcade on your worpress website, in this way your users will be more involved and will stay connected longer.

It's possible to add Ads banner at the beginning of each game and at the end of each level. This will give you a new tool to increase your revenues.

Your own users will promote your website sharing their scores on the main Social Networks, with no extra costs for you.

You'll get by default the score-sharing on Twitter. To add Facebook just follow the guideline below.

3 widgets can be added in your pages through a shortcode.

• Game iframe
• Rate the Game
• Leaderboard

Minimum Requirements:

• PHP 4.3
• WordPress 4.3.1
• HTML5
• Canvas
• Javascript / jQuery

This plugin is designed to work only with games built by Code This Lab.

You can find it here!

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.

CODE THIS LAB S.R.L.

Go To Table of Contents

---