“Watercraft Rush” Documentation by “Code This Lab S.r.l.” v1.0

“Watercraft Rush”

Created: 25/05/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!

Description
Folder Contents
Getting Started
HTML Structure
CSS Files and Structure
Source Code
Game functions
Change Graphic
Disable Sounds
Game Customization
Wordpress Plugin

A) Description - top

Watercraft Rush is a HTML5 Racing Game. Start the engine and ride through three worlds with three different tracks of increasing difficulty each. Avoid obstacles and complete all the laps before the time runs out!

The ZIP package contains the game with 1600x960 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 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

                                    TEXT_PRELOADER_CONTINUE = "START";
                                    TEXT_GAMEOVER  = "CONGRATULATION! YOU COMPLETED ALL TRACKS!";
                                    TEXT_TIME_IS_UP = "TIME IS UP!";
                                    TEXT_SCORE     = "SCORE";
                                    TEXT_GO = "GO!";
                                    TEXT_SPEED_INDICATOR = "Km/h";
                                    TEXT_SAVE_REMOVE = "THIS WILL REMOVE ALL YOUR ACHIEVEMENTS! DO YOU WANT TO PROCEED?";
                                    TEXT_ARE_SURE = "ARE YOU SURE?";
                                    TEXT_TRACK_COMPLETED = "TRACK COMPLETED";

                                    TEXT_SELECT_WORLD = "SELECT THE WORLD YOU WANT TO PLAY";
                                    TEXT_SELECT_TRACK = "SELECT TRACK";

                                    TEXT_HELP1     = "USE ARROW KEY TO MOVE THE CAR: UP FOR ACCELERATION AND DOWN FOR BRAKE";
                                    TEXT_HELP1_MOBILE     = "USE BUTTONS TO MOVE THE CAR";
                                    TEXT_HELP2     = "REACH THE END, BEFORE TIME GOES UP";

                                    TEXT_IOS_PRIVATE = 'Your web browser does not support storing settings locally. In Safari, the most common cause of this is using "Private Browsing Mode". Some info may not save or some features may not work properly';

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

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 SETTINGS
                                        player_max_speed: 12000,            //SET MAX SPEED OF THE PLAYER
                                        player_maxspeed_indicator: 200,     //VALUE ON THE TACHOMETER, WHEN PLAYER REACH THE MAX SPEED. YOU CAN CHANGE THE UNITS IN CLANG.
                                        player_centrifugal_force: 0.3,      //CENTRIFUGAL FORCE VALUE WHEN IN CURVE.

                                        /////////////SCORE SETTINGS
                                        points_per_seconds_remaining: 100, //Number of points gained per seconds remaining  

                                        /////////////GENERAL SETTINGS
                                        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:

jQuery
Our custom scripts
CreateJs plugin
Howler plugin
Screenfull plugin

jQuery is a Javascript library that greatly reduces the amount of code that you must write.
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 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
- CHelpPanel: the help panel that is shown before game starting
- CAreYouSurePanel: this class ensure the confirm to exit from game
- CCircularList: this class adds some help functionality
- CCreditsPanel: this class shows the credits
- CBackground: this class manages single background movement
- CHorizon: this class manages backgrounds parallax
- CCar: this class manages enemy cars in game
- CEndPanel: this class shows end panel when game is over
- CLevelBuilder: this class builds level stage
- CLevelBut: this class creates a level button
- CLocalStorage: this class manages game savings
- CLosePanel: this class shows lose panel when track is lose
- CMsgBox: this class shows a generic message panel
- CNextLevelPanel: this class shows win panel when track is win
- CPlayer: this class manages player car
- CRenderer: this class manages game rendering
- CRoad: this class manages road and road's elements
- CRollingText: this class manages text animations
- CTachometer: this class shows speed info
- CTimer: this class manages time elements in game
- CTrackMenu: this class manages track menu selection
- CTremble: this class manages tremble when damaged
- CWorldMenu: this class manages world menu selection
- levelsettings: this class manages all level track information. Use it to customize the track
- CTideController: this class manages tides generation
- CFoamParticle: this class manages watercraft foam animations
CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
Howler.js is a suite that manages the sounds
Screenfull.js manages the fullscreen functionality

Resuming, the complete game flow is the following:

The index.html file calls the CMain.js file after ready event is called
The main class calls CPreloader.js to init preloader text and start sprite loading
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
If the user click the Play button in main menu, the CWorldMenu.js class is called and user can choose a level
If the user click on a level button in level menu, the CGame.js class is called and game starts
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.
nextLevel()
This function is called when the level is over.
unload
This function is called when user want to exit from the game.
gameOver()
This function is called when game is over.
_ambientCollision()
This function is called to check collision on elements.
_carsCollision()
This function is called to check collision on other cars.
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) Game Customization - top

You can modify the unit of measure of speed. For example if you want to set speed in mp/h, just modify variable TEXT_SPEED_INDICATOR, in CLang.
You can modify the aspect and the ambient of every track. You can find the paramenters in levelsettings.js file.

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