“Greyhound Racing” Documentation by “Code This Lab S.r.l.” v1.0

---

“Greyhound Racing”

---

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. Hide Credits
9. Disable Sounds
10. Wordpress Plugin

---

A) Description - top

Greyhound Racing is a HTML5 Casino game. Try your luck betting with this stylish 3D version of Greyhound Racing Game!
The ZIP package contains the game with 1024x768 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 Resize: All game resolution automatically center itself and fits on the screen thanks to the ctl_utils.js file. If you want to avoid this, comment this function in index.html:

					$(window).ready(function() {
						/*
						if(isIOS()){
							 setTimeout(function(){sizeHandler();},200);
						 }else{
							 sizeHandler();
						 }
						 */
					});
				

• 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

					var TEXT_CURRENCY = "$";
					var TEXT_START_RACE = "START RACE";
					var TEXT_CLEAR_BET = "CLEAR BET";
					var TEXT_MONEY = "MONEY";
					var TEXT_BET = "BET";
					var TEXT_MIN_BET = "MIN BET";
					var TEXT_MAX_BET = "MAX BET";
					var TEXT_TRAP = "TRAP";
					var TEXT_GREYHOUND_NAME = "GREYHOUND NAME";
					var TEXT_ODDS = "ODDS";
					var TEXT_WINS = "WINS";
					var TEXT_PLACE = "PLACE";
					var TEXT_SHOW = "SHOW";
					var TEXT_WIN = "WIN";
					var TEXT_NO_WIN = "NO WIN";
					var TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";
					var TEXT_NO_MONEY = "NOT ENOUGH MONEY!!";
					var TEXT_ERR_MAX_BET = "YOUR BET IS HIGHER THAN MAXIMUM ONE!!";
					var TEXT_ERR_MIN_BET = "YOUR BET IS LOWER THAN MINIMUM ONE!!";
					var TEXT_ARE_YOU_SURE = "ALL YOUR BETS WILL BE LOST!! ARE YOU SURE?";
					var TEXT_RECHARGE = "RECHARGE";

					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({
										money:100,            //USER MONEY
										min_bet:1,            //MINIMUM BET
										max_bet:100,          //MAXIMUM BET
										win_occurrence: 30,   //WIN OCCURRENCE
										game_cash:100,        //GAME CASH. STARTING MONEY THAT THE GAME CAN DELIVER.
										chip_values:[1,5,10,25,50,100], //VALUE OF CHIPS
										show_credits:true, //SET THIS VALUE TO FALSE IF YOU DON'T TO SHOW CREDITS BUTTON
										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 
										check_orientation:true,     //SET TO FALSE IF YOU DON'T WANT TO SHOW ORIENTATION ALERT ON MOBILE DEVICES
										num_levels_for_ads: 2 //NUMBER OF TURNS PLAYED BEFORE AD SHOWING //
												//////// THIS FEATURE  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 7 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:
   • 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
   • CGfxButton: this class create a standard button
   • CTextButton: this class create a standard text button
   • CToggleButton: this class create a toggle 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
   • CArrivalPanel: this class manages the panel shown when greyhounds pass arrival line
   • CBetList: this class store all the info about betting
   • CBetPanel: this class manages the panel where user can bet
   • CButBet: this class creates a bet button
   • CButStartRace: this class creates the starting race button
   • CChipPanel: this class manages the chip panel in Betting Panel
   • CCreditsPanel: this class manages the Credits Panel
   • CFichesController: this class manages the chip piles into Bet Panel
   • CForecastPanel: this class manages the Forecast Panel into Bet Panel
   • CGameSettings: this class stores all the info about greyhounds and game
   • CGreyhound: this class manages the greyhound spritesheet
   • CLosePanel: this class show the Losing Panel when user loses
   • CMsgBox: this class manages the Message Box that is show when there is an error
   • CRankingGui: this class manages rank interface viisble in the bottom of the game
   • CSimpleBetPanel: this class manages the Single Bet Panel into Betting panel
   • CTrackBg: this class manages the Track movement
   • CWinPanel: this class show the Winning Panel when user wins
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 CBetPanel.js class is called and the user can start betting
5. Once user makes own bets, game starts with greyhound racing
6. If the player's credit is over a game over panel is shown
7. If user click on the exit button in the up-right corner, the game returns to the Bet 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 greyhounds.
• unload()
  This function removes all images from canvas and event listeners on buttons. It's called when user decide to exit from the game.
• generateFinalRank()
  This function decide if user must lose or win according to win occurrence.
• _generateWinResult()
  This function calculate a winning final result for the user.
• _generateLosingResult()
  This function calculate a losing final result for the user.
• update()
  The main game loop useful for greyhounf, track and other item movements.

---

H) Hide Credits - top

If you want to hide credits in main menu, change to false the following value in index.html file:

show_credits:false

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

---