“3D Lottery” Documentation by “Code This Lab S.r.l.” v1.0

---

“3D Lottery”

---

Table of Contents

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

---

A) Description - top

Try your luck and enjoy this 3D Lottery Game. Pick your favourite 8 lucky numbers, launch the draw and start dreaming! If you match 3 or more numbers, you'll get a prize*! (Please note this game is meant to be used for fun, no real prizes will be provided)
The ZIP package contains the game with 1200x1200 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-known 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 Content - top

1. ctl_arcade_wp_plugin:
This folder contains the zip package that can be used with our Wordpress plugin "CTL Arcade" (http://codecanyon.net/item/ctl-arcade-wordpress-plugin/13856421).
2. game
This folder contains the full game source code ready to be edited.
3. live_demo
This folder contains the obfuscated code. You should upload this folder on your server if you don't need to make any changes.
4. readme
This folder contains the package instructions.
5. thumbs
This folder contains all game icons.

---

C) Getting Started - top

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

• 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,iPrizeIndex) {
                                                              if(getParamValue('ctl-arcade') === "true"){
                                                                  parent.__ctlArcadeSaveScore({score:iPrizeIndex});
                                                              }
                                                              //...ADD YOUR CODE HERE EVENTUALLY
                                                       });
                                              });
  					

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

                                    var TEXT_START = "START";
                                    var TEXT_ARE_SURE = "ARE YOU SURE YOU WANT TO QUIT THE GAME?";
                                    var TEXT_PAYTABLE = "THE SUM OF ALL WIN OCCURENCES IN paytable_settings IS HIGHER THAN 100. TO MAKE THE GAME WORKING PROPERLY, PLEASE FIX THE VALUES IN index.html";

                                    var TEXT_PICK_NUMBERS = "PICK %s NUMBERS";
                                    var TEXT_PICK_NUMBERS_SINGLE = "PICK %s NUMBER";
                                    var TEXT_LETS_PLAY = "LET'S PLAY!";
                                    var TEXT_YOUR_NUMBERS = "YOUR NUMBERS";
                                    var TEXT_CONGRATULATIONS = "CONGRATULATIONS!";
                                    var TEXT_CONGRATULATIONS_EXPL = "YOU MATCHED %d NUMBERS";
                                    var TEXT_CONGRATULATIONS_EXPL_SINGLE = "YOU MATCHED %d NUMBER";
                                    var TEXT_GAMEOVER = "GAME OVER";
                                    var TEXT_MATCH = "MATCH!";
                                    var TEXT_HELP = "CLICK %s TO LAUNCH THE DRAW!";
                                    var TEXT_REDEEM = "REDEEM";

                                    var TEXT_DEVELOPED = "DEVELOPED BY";

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

Share your score with your friends!";
                                    var TEXT_SHARE_SHARE1 = "My score is ";
                                    var 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
                                        audio_enable_on_startup:false,  //ENABLE/DISABLE AUDIO WHEN GAME STARTS 
                                        show_credits:true,              //ENABLE/DISABLE INFO CREDITS BUTTON

                                        //PAYTABLE_SETTINGS: IN THIS FIELD YOU CAN SET THE OCCURRENCE OF EACH PRIZE BASED ON THE NUMBER OF BALLS GUESSED BY THE PLAYER
                                            //      -num_balls_matched: NUMBER OF BALLS GUESSED BY THE PLAYER
                                            //      -prize_img_url: THE IMAGE OF THE PRIZE FOR THAT COMBINATION OF GUESSED BALLS. 
                                            //                      IF YOU DON'T WANT ANY WIN FOR THAT COMBINATION, PLEASE LEAVE THE FIELD EMPTY (e.g. prize_img_url: "")
                                            //      -win_occurrence:    THE WIN OCCURRENCE OF THAT PRIZE. THE NUMBER IS BASED ON 100 DRAWS. 
                                            //                          THE SUM OF ALL WIN OCCURENCES SHOULD NOT BE HIGHER THEN 100.
                                            //      -label: INSERT A DESCRIPTION OF THE OBJECT. IF YOU DON'T WANT TO ADD ANY LABEL, LEAVE THE FIELD AS IT IS.
                                            //      -redeemlink:    INSERT A REDEEM LINK FOR THE OBJECT. IF YOU DON'T WANT TO ADD ANY LINK, LEAVE THE FIELD AS IT IS: (redeemlink: "").
                                            //                      YOU CAN ALSO ADD A LINK FOR NO PRIZE WINNING

                                        paytable_settings:[
                                            {num_balls_matched: 8, prize_img_url: "./sprites/item_prize_images/image_5.png", win_occurrence:0.1, label: "CAR", redeem_link: "http://www.codethislab.com/"},
                                            {num_balls_matched: 7, prize_img_url: "./sprites/item_prize_images/image_3.png", win_occurrence:1, label: "TRAVEL", redeem_link: "http://www.codethislab.com/"},
                                            {num_balls_matched: 6, prize_img_url: "./sprites/item_prize_images/image_4.png", win_occurrence:2, label: "MOTORCYCLE", redeem_link: "http://www.codethislab.com/"},
                                            {num_balls_matched: 5, prize_img_url: "./sprites/item_prize_images/image_0.png", win_occurrence:3, label: "SMARTPHONE", redeem_link: "http://www.codethislab.com/"},
                                            {num_balls_matched: 4, prize_img_url: "./sprites/item_prize_images/image_1.png", win_occurrence:5, label: "SUNGLASSES", redeem_link: "http://www.codethislab.com/"},
                                            {num_balls_matched: 3, prize_img_url: "./sprites/item_prize_images/image_2.png", win_occurrence:10, label: "DINNER", redeem_link: "http://www.codethislab.com/"},
                                            {num_balls_matched: 2, prize_img_url: "", win_occurrence:43.9, label: "", redeem_link: ""},
                                            {num_balls_matched: 1, prize_img_url: "", win_occurrence:25, label: "", redeem_link: ""},
                                            {num_balls_matched: 0, prize_img_url: "", win_occurrence:10, label: "", redeem_link: ""}
                                        ]

                                    });
				

---

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 Sound library

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:
   • smoothie: this class shows stats of performance in debug
   • Stats: this class shows stats of performance in debug
   • cannon.demo: this class manages physics utility and scene of the game
   • cannon: this class manages physics of the game
   • dat.gui: this class is used by cannon.js
   • Detector: this class is used by cannon.js
   • CScenario: this class manage building of 3D level
   • Three: this class manages 3D camera and view
   • CanvasRenderer: this class is used by Three.js
   • CanvasRenderer: this class is used by Three.js
   • Projector: this class is used by Three.js
   • SoftwareRenderer: this class is used by Three.js
   • TrackballControls: this class is used by Three.js
   • FBXLoader: this class is used to load 3D models in FBX format
   • CCTLText: this class manages the texts
   • CGUIExpandible: this class manages the expandible gui button
   • ios_fullscreen: this class manages the fullscreen feature for ios
   • platform: this class manages the detect of devices and browser
   • screenfull: this class manages the fullscreen
   • sprintf: this class manages the text format
   • CGfxButton: this class create a standard button
   • CTextButton: this class create a standard text button
   • CToggle: this class create a toggle button
   • CToggleExtraction: this class create the toggle start button for extraction
   • 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 preloader that shows resources loading progress
   • CMenu: simple menu with a play button
   • CGame: this class manages the game logic
   • CInterface: this class controls the game GUI that contains text and buttons
   • CAreYouSure: this class manage panel is shown when exit button is pressed
   • CCreditsPanel: this class manages the Credits Panel
   • CBall: this class manages the balls in the game
   • CHelpPanel: this class manages the help messages for players
   • CLosePanel: this class manages the lose panel
   • CWinPanel: this class manages the win panel
   • CNumberBut: this class manages the select number button
   • CNumMatchedPanel: this class manages the display of num matched panel
   • CPaytable: this class manages the paytable panel
   • CPaytableSlot: this class manages the paytable slot item
   • CPlayedNumbersInfoPanel: this class manages the info panel
   • CSelectNumbersPanel: this class manages the select numbers panel
3. CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
4. Howler is a javascript Audio library.

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 resources loading
3. When all resources contained in "/sprites" folder 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 on the play button in main menu, the CSelectNumbersPanel.js & CGame.js class are called and the user can choose own numbers to play
5. Once user choose a combination, the game can start and when the player click on start button, the extraction will begin
6. when the extraction finish, the winpanel/losepanel is shown
7. If user click on the exit button in the up-right corner, the game returns to the Menu panel

---

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 jigsaw pieces.
• unload()
  This function removes all images from canvas and event listeners on buttons. It's called when user decide to exit from the game.
• _initProbability()
  This function init the prizes probability.
• startBallsShuffle()
  This function move balls in to the container.
• chooseABallToExtract()
  This function choose a ball to extract and continue until all balls are extracted.
• update()
  The main game loop useful game time.

---

H) Change Graphic - top

You can easily change all the game graphic, replacing all the file you need in the "/sprites" folder. Just respect file format (.png or .jpg) and size if you don't want to change any code line.

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

---