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


“Slot Car Racing”

Created: 23/06/2018
By: Code This Lab S.r.l.
Email: info@codethislab.com

Thank you for purchasing our game. If you have any questions that are beyond the scope of this help file, please feel free to email via user page contact form here. Thanks so much!


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

A) Description - top

Slot Car Racing is a HTML5 Racing game. Are you ready to revive the best days of your childhood? Play solo choosing between "Quick Race" or "Challenge" mode across 4 degrees of difficulty. Or challenge a friend in 8 tracks of increasing difficulty!

The ZIP package contains the game with 960x540 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:
  2. 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).
  3. game
  4. This folder contains the full game source code ready to be edited.
  5. live_demo
  6. This folder contains the obfuscated code. You should upload this folder on your server if you don't need to make any changes.
  7. readme
  8. This folder contains the package instructions.
  9. thumbs
  10. This folder contains all game icons.

C) Getting Started - top

To install the game just upload on your server the game folder live_demo.


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 5 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 creates a standard button
    • CTextButton: this class creates a standard text button
    • CToggle: this class creates a toggle button
    • CGame: this class manages the game logic
    • CInterface: this class controls the game GUI that contains text and buttons
    • CAreYouSurePanel: this class manage panel is shown when exit button is pressed
    • CAlertSavingBox: this class manages the alert panel that is shown when local storage is not available on current device
    • CBezier: this class calculates the bezier curve points of the track rail.
    • CEasing: this class stores all math function for easing
    • CTweenController: this class manages tweens
    • CVector2: this class manages points
    • CMath: this class contains some useful math functions
    • CButModeMenu: this class creates a button into Menu Mode
    • CButPlayerMobile: this class creates the player buttons on mobile devices
    • CHelpPanel: this class shows the help panel before game starts
    • CCar: this class manages the cars
    • CCarInfoPanel: this class manages the car info panel in the GUI
    • CCarSelectionMsgBox: this class manages the GUI for the selection of the car.
    • CCollisionRectangle: this class draws the collision bounding box of ther car
    • CCountdown: this class manages the semaphore used for race start.
    • CEndRaceAnim: this class manages the flag animation when race is over
    • CGUIExpandible: this class manages expandible GUI in the game.
    • CLevelBut: this class creates a button into Level Menu
    • CLevelMenu: this class manages the panel where user select the track
    • CLevelSettings: this class stores all the info about tracks
    • CCreditsPanel: this class manages the Credits Panel
    • CMenuDifficulty: this class shows a panel where user can choose game difficulty
    • CMenuMode: this class shows a panel where user can choose game mode
    • CMenuSelectCar: this class shows a panel where user can choose the car
    • CRaceOverPanel: this class shows a panel where user can choose the car
  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. In the main menu user can choose 1 or 2 players
  5. If player 1 is choosed, Mode Menu is shown. User can choose Quick Race or Challenge
  6. After Mode selection, Difficulty Menu is shown
  7. Once the user chooses the difficulty, Level Menu is shown
  8. Once the user chooses the track, Selection Car Menu is shown
  9. Once the user chooses the car, game starts
  10. If player 2 is choosed, Level Menu is shown
  11. Once the user chooses the track, Selection Car Menu is shown
  12. Once the user chooses the car, game starts
  13. When a match is over, the game over panel is shown
  14. If user click on the exit button in the up-right corner, the game returns to the Menu panel

G) Game functions - top

In this section will be explained all the most important functions used in CGame.js file.


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.

Minimum Requirements:

This plugin is designed to work only with games built by Code This Lab.

You can find it here!

ctl arcade

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