“Cycle Sprint” Documentation by “Code This Lab S.r.l.” v1.0

---

“Cycle Sprint”

---

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

Customize your cyclist and perfect your bike for a thrilling adventure! Compete in Italy, France and Spain. Win all 63 races and earn your spot on the podium of champions!

The ZIP package contains the game with 1920x1080 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. game_old_version
This folder contains the previous version of the game that is deprecated and no longer updated.
4. 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.
5. readme
This folder contains the package instructions.
6. thumbs
This folder contains all game icons.

---

B)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_ARE_SURE_RESTART = "DO YOU WANT TO RESTART?";
									var TEXT_ARE_SURE_EXIT = "DO YOU WANT TO QUIT THE GAME?";
									var TEXT_CONFIRM_DELETE = "ALL SAVING WILL BE LOST! ARE YOU SURE?";
									var TEXT_SCORE = "SCORE";
									var TEXT_TOUR_SCORE = "RACE SCORE";
									var TEXT_TOT_SCORE = "TOTAL SCORE";
									var TEXT_GAME_OVER = "GAME OVER";

									var TEXT_TUTORIAL_1 = "PRESS KEY UP AND DOWN TO SHIFT BETWEEN LANES";
									var TEXT_TUTORIAL_2 = "PRESS SPACEBAR TO USE THE BOOST!";
									var TEXT_TUTORIAL_3 = "JUST BE CAREFUL NOT RUNNING OUT OF YOUR ENERGY!";
									var TEXT_TUTORIAL_MOBILE_1 = "PRESS ARROW UP AND DOWN TO SHIFT BETWEEN LANES";
									var TEXT_TUTORIAL_MOBILE_2 = "PRESS THIS BUTTON TO USE THEBOOST!";
									var TEXT_TUTORIAL_MOBILE_3 = "JUST BE CAREFUL NOT RUNNING OUT OF YOUR ENERGY!";

									var TEXT_TUTORIAL_4 = "COLLECT BOTTLES TO INCREASE YOUR ENERGY";

									var TEXT_RACE = "RACE %s"; 
									var TEXT_LEVEL_SCORE = "LEVEL SCORE\n%s";
									var TEXT_TOTAL_SCORE = "TOTAL SCORE\n%s";
									var TEXT_POS = "POS";
									var TEXT_CYCLIST = "CYCLIST";
									var TEXT_NAME_PLAYER = "PLAYER";
									var TEXT_PT = "pt";
									var TEXT_GAME_OVER = "GAME OVER";
									var TEXT_LOSE_HELP = "YOU RANKED %s! GET IN THE TOP 15 TO ADVANCE TO THE NEXT RACE!";
									var TEXT_FINAL_PANEL = "RACE COMPLETED!";

									var OPPONENT_NAMES = new Array();
									OPPONENT_NAMES[0] = "PLAYER";
									OPPONENT_NAMES[1] = "Max Paint";
									OPPONENT_NAMES[2] = "Alex Bankers";
									OPPONENT_NAMES[3] = "Stefan Sager";
									OPPONENT_NAMES[4] = "Gene Handsome";
									OPPONENT_NAMES[5] = "Mario Aversa";
									OPPONENT_NAMES[6] = "Chris Clark";
									OPPONENT_NAMES[7] = "Andre Hibbert";
									OPPONENT_NAMES[8] = "Jacques Fignon";
									OPPONENT_NAMES[9] = "Luka Goddard";
									OPPONENT_NAMES[10] = "Carlos Montoya";
									OPPONENT_NAMES[11] = "Jordyn Allison";
									OPPONENT_NAMES[12] = "Marcel Marsh";
									OPPONENT_NAMES[13] = "Jan Van Beck";
									OPPONENT_NAMES[14] = "Jordi Holland";

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

---

C)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({
												leaderboard_points: [50,35,25,18,14,12,10,8,7,6,5,4,3,2,1],    //POINTS ASSIGNED FOR FIRST 15 CYCLIST
                                                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
                                                audio_enable_on_startup: false  //ENABLE/DISABLE AUDIO WHEN GAME STARTS 
                                           });
				

---

D) 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

---

E) 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 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.min: 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
   • CAlertSavingBox: this class shows an alert panel when local storage is not available.
   • CAreYouSurePanel: this class shows warning panel that ask you if you want to exit
   • CBackgroundController: this class manages background movement.
   • CButCyclePart: this class creates a button into Editor panel
   • CButTournament: this class creates a button in the tournament panel
   • CCreditsPanel: this class shows the credits panel.
   • CGuiExpandible: this class manages the Expandible GUI that is shown when Settings button is clicked
   • CGameOver: this class shows the game over panel when user loses
   • CHelpPanel: this class shows the help panel
   • CController: this class manages controller keys for desktop devices and buttons for mobile
   • CCyclist: this class manages the cyclist spritesheet.
   • CEditorPanel: this class manages the editor Panel where user can customize the cyclist.
   • CLocalSavings: this class manages the local savings of the game.
   • CEndPanel: this class shows a panel with the final race leaderboard
   • CLaneHighlight: this class manages road lanes
   • CLeaderBoardPanel: this class shows a message box with the leaderboard
   • CLeaderBoardController: this class shows a leaderboard
   • CLeaderboardRow: this class creates the single leaderboard row
   • CLevelSettings: this class stores all the level infos
   • COpponentSettings: this class stores all the opponent infos
   • CRadarController: this class manages the track radar
   • CRoadTile: this class manages the road sprite used in class CBackgroundController
   • CRollingTextController: this class manages a rolling effect on a text
   • CScoreTextAnim: this class creates a floating text
   • CStaminaController: this class manages the cyclist stamina GUI
   • CStaminaItem: this class manages the stamina item on the road
   • CTournamentSelection: this class shows the tournament panel
   • CTutorialPanel: this class shows the tutorial panel
   • CWinPanel: this class is shown when a tournament is over
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 click the Play button in main menu, the CTournamentSelection.js class is shown
5. Once a tournament is selected, the game starts
6. If the user click on the exit button in the up-right corner, the game returns to the menu screen

---

F) 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), cyclists and the GUI.
• _onUserActionInput()
  This function is called when user press a directional key or button.
• resetValues()
  This function reset all game parameters when the game restarts.
• _prepareOpponents()
  This function creates all cyclist instances.
• _onFinishLine()
  This function is called when the race arrival is shown.
• unload
  This function is called when user want to exit from the game.
• _checkLaneDistance()
  This function check if player collides with other cyclists.
• gameOver()
  This function is called when the race is over.
• update()
  This function manages the main game loop.

---

G) 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.

H) 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;

I) 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

---