“Christmas shooter” Documentation by “Code This Lab S.r.l.” v1.0

---

“Christmas shooter”

---

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 Ball Graphic
9. New Levels
10. Disable Sounds
11. Wordpress Plugin

---

A) Description - top

Christmas shooter is a HTML5 classic arcade game. The goal of the game is to clear all the balls from the level avoiding any ball crossing the bottom line.
The ZIP package contains the game at 870x1504 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 folder live_demo.

• Game Resize: All game resolution automatically center itself and fits on the screen thanks to the ctl_utils.js file. If you want to avoid this, comment this function in this way:

					$(window).ready(function() {
						/*
						if(isIOS()){
                            setTimeout(function(){sizeHandler();},200); 
                        }else{ 
                            sizeHandler(); 
                        }
						*/
					});
				

• 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(){
  							$(oMain).on("save_score", function(evt,iScore) {
  								//ADD YOUR CODE HERE
  							});
  						});
  					

• Localization: You can easily change game text editing the fileCLang.js

					TEXT_GAMEOVER   = "GAME OVER";
					TEXT_CONGRATS   = "CONGRATULATIONS";
					TEXT_SCORE      = "SCORE";
					TEXT_LEVEL      = "LEVEL";
					TEXT_PLAY       = "PLAY";
					TEXT_NEXT       = "NEXT";
					TEXT_INCREDIBLE = "INCREDIBILE!!!";
					TEXT_EXCELLENT  = "EXCELLENT!!";
					TEXT_VERYGOOD   = "VERY GOOD!";
					TEXT_GOOD       = "GOOD!";
					TEXT_COMPLETED  = "COMPLETED";
					TEXT_HELP       = "DESTROY ALL THE COLORED XMAS BALLS FROM THE LEVEL, LAUNCHING A BALL ON GROUPS OF THE SAME COLOR.";
					TEXT_SELECT_LEVEL = "SELECT A LEVEL";
					TEXT_CONTINUE   = "CONTINUE";
					TEXT_DELETE_SAVINGS =  "ALL YOUR PROGRESS WILL BE DELETED! ARE YOU SURE?";
					TEXT_NO         = "NO";
					TEXT_YES        = "YES";
					TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";
					TEXT_ERR_LS = "YOUR WEB BROWSER DOES NOT SUPPORT STORING SETTING LOCALLY. IN SAFARI, THE MOST COMMON CAUSE OF THIS IS USING 'PRIVATE BROWSING MODE'. SOME INFO MAY NOT SAVE OR SOME FEATURE MAY NOT WORK PROPERLY.";

					TEXT_CONGRATULATIONS = "Congratulations!";
					TEXT_MSG_SHARE1 = "You collected ";
					TEXT_MSG_SHARE2= " points!

Share your score with your friends!";
					TEXT_MSG_SHARING1 = "My score is ";
					TEXT_MSG_SHARING2 = " points! Can you do better?";
					

• Game option: You can easily customize game setting in index.html file

					var oMain = new CMain({
												board_y:390,         //Y OF BALL ATTACH
                                                ball_speed: 4,       //BALL SPEED
                                                shot_for_ceiling: 5, //NUMBER OF SHOT BEFORE CEIL GOES DOWN
                                                score_explosion:15,  //POINTS FOR EACH BALL EXPLOSION
                                                score_fall:20,       //POINTS FOR EACH FALLEN BALL
                                                audio_enable_on_startup:false, //ENABLE/DISABLE AUDIO WHEN GAME STARTS
                                                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 game panels

---

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 game sounds, 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
   • CSettings: general game settings
   • 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
   • CGfxButton: this class create a standard button
   • CTextButton: this class create a standard text button
   • CToggle: this class create a standard toggle button
   • CHelpPanel: this class manages the help panel that appears when game starts
   • CGame: this class manages the game logic
   • CInterface: this class controls game GUI that contains text and buttons
   • CMath: this class contains some math function
   • CEndPanel: this class controls the game over/win panel
   • CNextLevelPanel: this class shows the next level panel
   • CBall: this class manages the ball object
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 and sounds (if not mobile) 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. If player clear all balls from level, the game shows a Next Level Panel with the level score. If player loses, the game shows a game over panel
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), GUI and help panel.
• _initLevel()
  This function draw all ball in the current level.
• resetLevel()
  This function load the next level to play.
• _gameOver()
  This function is called when user loose.
• _win()
  This function is called when user finish the game.
• tapScreen()
  This function is called when user click on the screen to launch the ball.
• _updatePhysics()
  This function manages the game physics.

---

H) Change Ball Graphic - top

The game contains the ball and animation spritesheets that you can edit if you want to change the graphic:

• balls.png: this image contains all ball symbols.
  
  
  
  

  				var oSprite = s_oSpriteLibrary.getSprite('balls');
  				_iBallDim = Math.floor(oSprite.width/NUM_BALL_COLORS);
  				
  				var oData = {   
  								images: [oSprite], 
  								// width, height & registration point of each sprite
  								frames: {width: _iBallDim, height: oSprite.height, regX: 0, regY: 0}, 
  								animations: {ball_0:[9],ball_1:[0],ball_2:[1],ball_3:[2],ball_4:[3],ball_5:[4],
  																				ball_6:[5],ball_7:[6],ball_8:[7],ball_9:[8]}
  							};
  				
  				_oBallSpriteSheet = new createjs.SpriteSheet(oData);
  			

• ball_explosion.png: this image contains explosion animation.
  
  
  
  

  				var oSprite = s_oSpriteLibrary.getSprite('ball_explosion');
  				var oData = {   
                          images: [oSprite], 
                          // width, height & registration point of each sprite
                          frames: {width: 150, height: 150, regX: 50, regY: 40}, 
                          animations: {explosion:[0,14,"invisible"],invisible:[15]}
                      };
          
  				var oExplosionSpriteSheet = new createjs.SpriteSheet(oData);
  			

I)New Levels - top

Please keep in mind that this package contains 5 levels. So if you need some other levels, you can buy them here
We sell the following levels separately:

• Level 1
  
  
  
  
• Level 2
  
  
  
  
• Level 3
  
  
  
  
• Level 4
  
  
  
  
• Level 5
  
  
  
  
• Level 6
  
  
  
  
• Level 7
  
  
  
  
• Level 8
  
  
  
  
• Level 9
  
  
  
  
• Level 10
  
  
  
  
• Level 11
  
  
  
  
• Level 12
  
  
  
  
• Level 13
  
  
  
  
• Level 14
  
  
  
  
• Level 15
  
  
  
  
• Level 16
  
  
  
  
• Level 17
  
  
  
  
• Level 18
  
  
  
  
• Level 19
  
  
  
  
• Level 20
  
  
  
  
• Level 21
  
  
  
  
• Level 22
  
  
  
  
• Level 23
  
  
  
  
• Level 24
  
  
  
  
• Level 25
  
  
  
  
• Level 26
  
  
  
  
• Level 27
  
  
  
  
• Level 28
  
  
  
  
• Level 29
  
  
  
  
• Level 30
  
  
  
  
• Level 31
  
  
  
  
• Level 32
  
  
  
  
• Level 33
  
  
  
  
• Level 34
  
  
  
  
• Level 35
  
  
  
  
• Level 36
  
  
  
  
• Level 37
  
  
  
  
• Level 38
  
  
  
  
• Level 39
  
  
  
  
• Level 40
  
  
  
  
• Level 41
  
  
  
  
• Level 42
  
  
  
  
• Level 43
  
  
  
  
• Level 44
  
  
  
  
• Level 45
  
  
  
  
• Level 46
  
  
  
  
• Level 47
  
  
  
  
• Level 48
  
  
  
  
• Level 49
  
  
  
  
• Level 50
  
  
  
  

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

---