“Rocking Wheels” Documentation by “Code This Lab S.r.l.” v1.0

---

“Rocking Wheels”

---

Table of Contents

1. Description
2. Folder Contents
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

Rocking Wheels is a HTML5 Racing Game.
Your band is late for the concert! Run as fast as you can to not disappoint your fans!
Travel across 30 stops of the tour and discover the wonders and dangers of the world!

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

• Game Embedding: The proper way to embed the game is in a full-screen web page or in an i-frame.
  In the first case the game will fit the screen size, in the second, that of the i-frame.
  If the i-frame 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

                                TEXT_HELP1 = "YOU'RE LATE FOR YOUR CONCERT! GO!";
                                TEXT_HELP_COIN = "COIN";
                                TEXT_HELP_FUEL = "FUEL";
                                TEXT_HELP_BOOST = "NITRO BOOST";
                                TEXT_HELP_MOBILE1 = "LEFT PEDAL TO BRAKE";
                                TEXT_HELP_MOBILE2 = "RIGHT PEDAL TO ACCELERATE";
                                TEXT_HELP_DESKTOP1 = "DOWN/RIGHT ARROW TO BRAKE";
                                TEXT_HELP_DESKTOP2 = "UP/LEFT ARROW TO ACCELERATE";
                                TEXT_WIN = "CONGRATULATIONS, YOU WON!";
                                TEXT_TRYAGAIN = "TRY AGAIN?";
                                TEXT_LOSE = "SORRY, YOU LOSE!";
                                TEXT_GAMEOVER_GAS = "YOU RAN OUT OF GAS!";
                                TEXT_GAMEOVER_TIME = "SORRY, TIME'S UP!";
                                TEXT_PAUSE = "PAUSE";
                                TEXT_ARE_SURE = "ARE YOU SURE YOU WANT TO EXIT?\nALL UNSAVED PROGRESS WILL BE LOST";
                                TEXT_BEST_SCORE = "BEST SCORE";
                                TEXT_NEW_BEST_SCORE = "NEW BEST SCORE";
                                TEXT_SCORE = "SCORE";
                                TEXT_UPGRADE = "UPGRADE YOUR VEHICLE";
                                TEXT_LEVEL = "LEVEL";
                                TEXT_MAXSPEED = "MAX SPEED";
                                TEXT_ACCELERATION = "ACCELERATION";
                                TEXT_NITRO = "NITRO";
                                TEXT_SELECT_LEVEL = "SELECT LEVEL";
                                TEXT_HURRYUP = "HURRY UP!";
                                TEXT_LOWGAS = "LOW GAS!";
                                TEXT_CONFIRM_RESET = "ARE YOU SURE YOU WANT TO RESET THE GAME?\nALL YOUR PROGRESS WILL BE LOST";
				

---

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 4 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({
                                        credits_start: 0,               // WITH HOW MANY CREDITS THE GAME WILL START THE FIRST TIME
                                        coin_value: 10,                 // HOW MANY CREDITS A TAKEN COIN IS VALUED
                                        all_levels_unlocked:false,      // SET ALL LEVELS UNLOCKED
                                        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
                                       });
				

---

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
5. Box2D

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
   • game_settings: advanced game settings for physic objects
   • 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
   • CTextButton: this class create a text button
   • CToggle: this class create a standard toggle button
   • CGame: this class manages the game logic
   • CInterface: this class controls game GUI that contains text and buttons
   • CAreYouSurePanel: this class manages the exit confirmation panel
   • CCreditsPanel: this class manages the credits panel
   • CLosePanel: this class manages the gameover panel when the player loses
   • CWinPanel: this class manages the end level panel when the player wins
   • CHelpPanel: this class manages the help panel
   • CMsgBox: this class manages the message box
   • CBonusObject: this class manages the creation and settings for bonus objects
   • CFloor: this class manages the floor
   • CPhysicObjectsCreator: this class create a physic object
   • CPhysicWorld: this class manages the physic world
   • CPhysicController: this class manages the physic objects
   • CStore: this class manages a store panel where to buy items
   • CStoreBut: this class create a store button
   • CConfirmResetPanel: this class manages the confirmation panel to reset data
   • CConfirmation: this class create a confirmation panel button
   • CEdgeModel: this class manages physic edges
   • CLevelChoose: a menu to select the level to play
   • CLevelSettings: a class settings each level
   • CLevelBut: this class create a level selection button
   • CMiniMap: this class creates and manages the mini screen to display player's position
   • CPause: this class manages the pause functions
   • CUpgradeButton: this class create a button used for upgrades
   • CUpgradePanel: this class manages the upgrades panel
   • CVector2: this class manages the vector settings and configuration
   • CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
   • Howler is a library that manages audio.
   • Box2D is a library that manages physic.

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 CLevelChoose.js class is called and the Level Select panel will appear
5. If the user selects a level in Level Select menu, the CGame.js class is called and the game starts
6. If the user click on the exit button in the down-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) and the GUI.
• restartGame()
  This function is called when user want to restart the game.
• unload()
  This function is called when user want to come back to the menu screen.
• addScore()
  This function sets new score earned by the player.
• _gameOver()
  This function sets a lost game.
• _gameWin()
  This function sets a won game.
• checkForArrival()
  This function checks if the player has arrived at the end of the track.
• checkCollisionWithBonus()
  This function checks if the player has collided with a bonus.

---

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

---