“Batter Challenge” Documentation by “Code This Lab S.r.l.” v1.0

“Batter Challenge”

Created: 21/07/2016
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 Content
Getting Started
HTML Structure
CSS Files and Structure
Source Code
Game functions
Change Graphic
Disable Sounds
Wordpress Plugin

A) Description - top

Batter Cricket Challenge is a HTML5 Sport Game. Challenge 6 different teams and show your batting skills!

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

ctl_arcade_wp_plugin:
game
live_demo
readme
thumbs

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_TEAM = ["Australia", "England", "India", "Pakistan", "South Africa", "Sri Lanka"];
					TEXT_GAMEOVER = "YOU RAN OUT OF BALLS.";
					TEXT_SCORE = "FINAL SCORE\n";
					TEXT_PAUSE = "PAUSE";
					TEXT_PANEL = "CONGRATULATIONS! YOU GOT";
					TEXT_PANEL_POINT = " POINTS";
					TEXT_BOWLED = "BOWLED!";
					SCORE_TEXT = "PTS: ";
					TEXT_START = "START";
					TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";
					TEXT_SELECT_YOUR_TEAM = "SELECT YOUR TEAM";
					TEXT_SELECT_OPPONENT_TEAM = "SELECT CPU TEAM";
					TEXT_LINK = "www.codethislab.com";
					TEXT_HIT = "HIT";
					TEXT_ARE_SURE = "ARE YOU SURE?";
					TEXT_CONGRATULATION = ["GOOD!", "GREAT!", "EXCELLENT!!!"];
					TEXT_LOADING = "LOADING";
					TEXT_HOW_TO_PLAY = "HOW TO PLAY";
					TEXT_HELP1_PC_BATTER = "PRESS CORRESPONDING KEY WHEN BALL TARGET BECAME GREEN";
					TEXT_HELP1_MOBILE_BATTER = "TOUCH CORRESPONDING ARRAY WHEN BALL TARGET BECAME GREEN";

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({
                    lives: 3, //THIS PARAM SET THE NUMBER OF LIVES
                    offset_hit: 100, //INCREASE THIS VALUE (PIXEL MEASURED) IF YOU WANT TO INCREASE PIXEL RANGE FOR BALL HITTING. IN THIS WAY BALL WILL BE MORE EASY TO HIT.
                    //DECREASE IT, IF YOU WANT TO MAKE THE GAME HARDER.
                    offset_perfect_hit: 20, //LIKE OFFSET_HIT PARAM, THIS VALUE MANAGE THE PIXEL RANGE TO PERFORM A PERFECT HIT (HOME RUN). INCREASE/DECREASE THIS VALUE TO GET PERFECT HIT MORE EASILY/BARELY
                    start_speed_ball: 1.3, //START SPEED BALL IN FRAMES STEPS
                    ball_velocity_added: 0.1, //ADDED THIS VALUE TO BALL VELOCITY EVERY BEAT IN FRAMES STEPS
                    max_ball_velocity: 2.4, //MAX VELOCITY OF BALL IN FRAMES STEPS
                    score_ball_hit: 120, //ADD SCORE WHEN BALL IS HIT, SCORE IS SUBTRACTED BY PRECISION OF HIT
                    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
                    num_levels_for_ads: 2//NUMBER OF TURNS PLAYED BEFORE AD SHOWING //
                            //////// THIS FEATURE  IS ACTIVATED ONLY WITH CTL ARCADE PLUGIN./////////////////////////// 
                            /////////////////// YOU CAN GET IT AT: ///////////////////////////////////////////////////////// 
                            // http://codecanyon.net/item/ctl-arcade-wordpress-plugin/13856421 ///////////
                });

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 Sound library

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
- CAreYouSurePanel: this class show are you sure panel.
- CBall: this class manage the ball.
- CBatter: this class manage batter player.
- CBowler: this class manage bowler player.
- CController: this class show controller mobile.
- CCreditsPanel: this class show credits panel.
- CEndPanel: this class show end panel.
- CHelpPanel: this class show help panel.
- CLoadingScreen: this class show the loading screen.
- CPause: this class show pause panel.
- CPole: this class manages a pole.
- CTeamChoose: this class show a menu with teams to choose.
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 javascript Audio library.

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 CTeamChoose.js class is called and show available teams
If the user click on a Team button in team choose menu and click on continue button, the CGame.js class is called and game starts
If the user click on the exit button in the up-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.
ballMissedRestart()
This function is called when a launched ball is missed.
randomDir()
This function determinate a random direction of ball launch.
launchCountdown()
This function is called when start the game.
resetGame()
This function restart the game.
_ballHitted()
This function is called when batter hitted the ball.
unload
This function is called when user want to exit from the game.
batterAnimation()
This function is update for play batter animation.
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) 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