“100 Metres Race” Documentation by “Code This Lab S.r.l.” v1.0

---

“100 Metres Race”

---

Table of Contents

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

---

A) Description - top

Challenge the best runners in the world and beat their time in the 100 metres race! Collect medals to increase your energy and step to the podium of champions!

The ZIP package contains the game with 1360x640 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 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 .
  
  
• Localization: You can easily change game text for different languages, changing string in CLang.js

				var TEXT_POSITION   = "° PLACE";
				var TEXT_SCORE      = "SCORE:       ";

				var TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";
				var TEXT_LINK1 = "WWW.CODETHISLAB.COM";

				var TEXT_START_MOVEMENT        = "MASH THE LEFT AND RIGHT KEYS TO BOOST YOUR POWER";
				var TEXT_START_MOVEMENT_MOBILE = "MASH THE LEFT AND RIGHT BUTTONS TO BOOST YOUR POWER";
				var HELP_ENERGY                = "KEEP YOUR ENERGY BAR FULL TO GO FASTER!";
				var TEXT_ON_EXIT               = "DO YOU REALLY WANT TO QUIT THE GAME?";
				var TEXT_ON_CAREER_RESET       = "ARE YOU SURE? ALL YOUR PREVIOUS SCORES WILL BE DELETED!";

				var TEXT_CURRENCY   = "$";
				var TEXT_LANE = "LANE";
				var TEXT_TIME = "Time";
				var TEXT_DISCIPLINE = "MEN'S 100 METRES";
				var TEXT_RESULT = "RESULT";
				var TEXT_UPGRADE = "Upgrades - Medals";
				var TEXT_BUY = "BUY";
				var TEXT_MONEY = "MONEY";
				var TEXT_ERR_LS = "YOUR WEB BROWSER DOES NOT SUPPORT LOCAL STORAGE. IF YOU'RE USING SAFARI, IT MAY BE RELATED TO PRIVATE BROWSING. AS A RESULT, SOME INFO MAY NOT BE SAVED OR SOME FEATURES MAY NOT BE AVAILABLE.";

				var TEXT_TEAM_0 = "GERMANY";
				var TEXT_TEAM_1 = "U.K.";
				var TEXT_TEAM_2 = "TRINIDAD AND TOBAGO";
				var TEXT_TEAM_3 = "RUSSIA";
				var TEXT_TEAM_4 = "JAMAICA";
				var TEXT_TEAM_5 = "U.S.A.";
				var TEXT_TEAM_6 = "FRANCE";
				var TEXT_TEAM_7 = "NETHERLANDS";

				var CITY_NAME = [   "SEATTLE",
									"SAN FRANCISCO",
									"MIAMI",
									"NEW ORLEANS",
									"CHICAGO",
									"WASHINGTON",
									"NEW YORK",
									"LOS ANGELES",
									"CLEVELAND",
									"RIO"]

				var TEXT_RUNNER    =   "SELECT RUNNER";
				var TEXT_MODE       =   "SELECT MODE";
				var TEXT_CHALLENGE  =   "SELECT TRACK";

				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";

				

---

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 8 mapped events that can be useful eventually for stats

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

					var oMain = new CMain({
												player_max_speed: 21,      //PLAYER MAXIMUM SPEED
                                                player_min_speed: 4,       //PLAYER MINIMUM SPEED
                                                player_energy: 100,        //PLAYER ENERGY
                                                player_resistence_step: 2, //THIS AMOUNT IS SUBTRACTED BY PLAYER ENERGY EVERY UPDATE 
                                                player_max_speed_adder: 1, //AMOUNT TO ADD WHEN USER BUY SPEED UPGRADE
                                                player_energy_adder: 5     //AMOUNT TO ADD WHEN USER BUY ENERGY UPGRADE
                                           });
				

---

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) Source Code - 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's loading, the loop game and initializes 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 play button
   • CGfxButton: this class creates a standard button
   • CToggle: this class creates a standard toggle button
   • CTextButton: this class creates a standard text button
   • CGame: this class manages the game logic
   • CInterface: this class controls game GUI that contains texts and buttons
   • CVector2: this class is the handler of vectors
   • CSelectTeam: this class allows the user to select the player
   • CEndPanel: this class shows the panel that will be spawned when all players have arrived to the goal
   • CRunner: this class manages runners
   • CScrollingBg: this class moves the BackGrounds based on the user's player speed
   • CHealthBar: this class handles the graphic energy left
   • CMobileControls: this class handles the controls on mobile devices
   • CPrintInfosOnPanel: this class creates the texts on the panel on the right when a player reaches the goal
   • CLevelMenu: this class allows the user to select the race to play, this class is used with "CLevelBut" class
   • CLevelBut: this class prints info on the objects of "CLevelMenu" Class
   • CCitySettings: general city settings
   • CShowNationalityInLane: shows flags nationality in each lane
   • CPlayerProgress: this class allows the user to buy PowerUps and to see his position on each City
   • CVariousHelp: this class shows various help, such as "help panel" and "are you sure?" panel
   • CPodiumScreen: Last panel, this will be shown after the last race, and shows the first 3 players on a podium
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 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 the user clicks the Play button in main menu, the CSelectTeam.js class is called. Once runner is selected, the "LevelMenu.js" class is shown.
5. When user choose a Track, the game starts.
6. If the user clicks 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), initializes the runner and the GUI.
• onKeyDown()
  This function reads the key pressed, in case it is one of the keys allowed (left or right), it will move runner.
• startGame()
  This function starts the game by playing the runner starting animation.
• startRunners()
  This function is called when the race is started.
• moveRunnersWithBG()
  This function is called to move BGs and enemies based on the player's speed.
• moveEnemies()
  This function simulates the button pressed to move each opponent.
• checkIfIsElapsedTooMuchTimeBetweenPress()
  This function is called to check how long it takes from the first and second press.
• gameOver()
  This function is called when all runners arrived to the goal.
• update()
  This function manages the main game loop.

---

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. Feel 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

---