“Drive Your Car” Documentation by “Code This Lab S.r.l.” v1.0

---

“Drive Your Car”

---

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. Spritesheets
9. Change Graphic
10. Disable Sounds
11. Wordpress Plugin

---

A) Description - top

Drive Your Car is a HTML5 run game. You control a sports car that must avoid opponent's vehicles. Your aim is to other cars for as long as possible, each crash cost you a life (you have three lives by default). The ZIP package contains the game with 960x768 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 .
  
  
• 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,score) {
  							//ADD YOUR CODE HERE
  						});
  					});
  				
  				

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

					TEXT_SCORE = "SCORE";
					TEXT_GAME_OVER = "GAME OVER";
					TEXT_JUMP = "JUMP";
					TEXT_PLAY = "PLAY";
					TEXT_HELP1 = "AVOID THE OPPOSING CARS CLICKING THE ARROWS OR THE JUMP BUTTON";
					TEXT_HELP2 = "TRY TO DRIVE AS LONG AS POSSIBLE";
					var TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";
					var TEXT_PRELOADER_CONTINUE = "START";

					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({
                            max_start_speed: 8,             //MAX SPEED YOUR CAR CAN REACH INITIALLY             
							increase_speed_up_interval:20,  //EACH 20 POINTS EARNED GAME IS FASTER
							increase_speed: 1,              //SPEED ADDED TO THE GAME AFTER INCREASE SPEED UP INTERVAL 
							dist_obstacles: 550,            //PIXEL DISTANCE AMONG OPPONENT CARS
							accelleration: 0.24,            //STARTING CAR ACCELLERATION. INCREASE THIS NUMBER TO REACH MAX SPEED FASTER
							score_increase: 1,              //SCORE INCREASE AMOUNT EACH SECOND
							malus_score: 0,                 //SET THIS TO POSITIVE INTEGER IF YOU WANT TO DECREASE SCORE AFTER CRASH
							lives:3,                         //NUMBER OF LIVES
							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
        });  
				

---

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 text preloader to show resources loading progress
   • CMenu: simple menu with play button
   • CTextButton: this class creates a standard button with text like the one into the menu section
   • CGfxButton: this class creates a standard button
   • CGame: this class manages the game logic
   • CHero: this class controls the car sprite and its position
   • CObstacle: this class controls the enemy cars and its position
   • CEndPanel: this class controls the game over panel that appears when player lose all the lives
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" 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 CGame.js class is called and the game starts
5. The game class shows immediately a help screen that explain briefly the game instructions. When user click on this panel, the game finally starts
6. Any time car crashes, user loose a life. When all lives are lost, the game shows a Game Over panel with the final score.
7. If user click on game over panel, 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 all game sprites like background (oBg), buttons, lives, score text and help panel.
• unload()
  This function removes event listeners on buttons. It's called when user decide to exit from the game.
• _initLineObjects()
  This function defines the three possible x position of the opponent cars and own car. It also attach background tiles on the canvas.
• _initObstacles()
  This function attaches various opponent sprites choosing their position randomly.
• _lifeLost()
  This function is called every time car crashes. It shows a red fade to simulate car hurt, decrease the score and remove a life. When user loses all lives, game over panel is called.
• _gameOver()
  This function calls the CEndPanel.js function that shows the Game Over panel
• _checkCollision()
  This function check if there is any collision between the car and its opponent. It calculate the radius distance between objects in scene.
• _updateMove()
  This function manages the graphic update of the background.
• updateObstacles()
  This function manages the opponent cars update. There are two if condition that must be verified during the update: 1) if opponent collides with the player car, its position is reset and a life is lost; 2) if opponent reach the canvas bottom, its y position is reset

---

H) Spritesheet - top

The game contains 1 the enemy spritesheet that you can edit if you want to change the graphic:

• enemy.png: this image contains 12 sprites that shows all the opponent car. When you'll change this with your graphic, remind to change the following code in CObstacle.js file
  
  
  
  

  				var oData = {   // image to use
                  framerate : 20,
                  images: [oSpriteRun], 
                  // x,y,width, height,page, x registration point, y registration point
                  frames:[[0,0,98,200,0,49,100],
                         [98,0,98,200,0,49,100],
                         [196,0,98,200,0,49,100],
                         [292,0,96,200,0,48,100],
                         [388,0,96,200,0,48,100],
                         [484,0,96,200,0,48,100],
                         [580,0,108,168,0,54,84],
                         [688,0,108,168,0,54,84],
                         [796,0,108,168,0,54,84],
                         [904,0,80,200,0,40,100],
                         [984,0,80,200,0,40,100],
                         [1064,0,80,200,0,40,100]
  
                  ],
                  animations: {  enemy_1: [0, 1],enemy_2: [1, 2],enemy_3: [2, 3],
                                 enemy_4: [3, 4],enemy_5: [4, 5],enemy_6: [5, 6],enemy_7: [6, 7],
                                 enemy_8: [7, 8],enemy_9: [8, 9],enemy_10: [9, 10],enemy_11: [10, 11],
                                 enemy_12: [11, 12],}
                          
          };
  			

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

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

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

---