“Bouncing Eggs#” Documentation by “Code This Lab S.r.l.” v1.0

---

“Bouncing Eggs”

---

Table of Contents

1. Description
2. Folder Content
3. Getting Started
4. HTML Structure
5. CSS Files and Structure
6. Source Code
7. Game functions
8. Change Graphic
9. Disable Sounds
10. Wordpress Plugin

---

A) Description - top

Bouncing Eggs is a HTML5 Physics game.Throw the falling eggs in the basket by bouncing them on the cloth and reach the target of every level.

The ZIP package contains the game with 840x1024 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 .
  
  
• Localization: You can easily change game text for different languages, changing string in CLang.js

                                    var TEXT_SELECT_A_LEVEL = "SELECT A LEVEL";
									var TEXT_CREDITS_DEVELOPED = "Developed by";
									var TEXT_WIN = "YOU WON";
									var TEXT_LOST = "YOU LOST";
									var TEXT_PAUSE = "PAUSE";
									var TEXT_ARE_SURE = "ARE YOU SURE?";
									var TEXT_LOSE_RESULT = "YOU THREW %s / %s EGGS";
									var TEXT_WIN_RESULT = "YOU THREW %s / %s EGGS";
									var TEXT_RESET = "ARE YOU SURE? ALL YOUR PREVIOUS SAVINGS WILL BE DELETED!";
									var TEXT_TOTAL_SCORE = "TOTAL SCORE: %s";
									var TEXT_LEVEL = "LEVEL %s";
									var TEXT_HELP1_DESKTOP = "MOVE THE BUNNIES WITH THE MOUSE TO BOUNCE THE EGGS";
									var TEXT_HELP1_MOBILE = "MOVE THE BUNNIES WITH THE FINGER TO BOUNCE THE EGGS";
									var TEXT_HELP2 = "THROW THE EGGS HERE";
									var TEXT_ERR_LS = "YOUR WEB BROWSER DOES NOT SUPPORT LOCAL STORAGE. IF YOU'RE USING SAFARI, IT MAY BE RELATED TO PRIVATE BROWSING. AS A RESULT, SOME INFO MAY NOT BE SAVED OR SOME FEATURES MAY NOT BE AVAILABLE.";

									var TEXT_SHARE_IMAGE = "200x200.jpg";
									var TEXT_SHARE_TITLE = "Congratulations!";
									var TEXT_SHARE_MSG1 = "You collected ";
									var TEXT_SHARE_MSG2 = " points!

Share your score with your friends!";
									var TEXT_SHARE_SHARE1 = "My score is ";
									var 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({
                                            egg_score: [10,20,30,40,50,100], //ADD SCORE WHEN THE EGG GO TO ANEMONE
											lives: 5, //START LIVES,
											bonus_scores: [100], //ADD SCORE WHEN BUNNIES TOUCH A BONUS || 0 HEART BONUS
											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    
											audio_enable_on_startup:false,  //ENABLE/DISABLE AUDIO WHEN GAME STARTS 
											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:

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 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
   • CAnemone: this class manages the anemone
   • CAreYouSurePanel: this class show are you sure panel.
   • CArrow: this class manages the arrow.
   • CBonus: this class manages the bonus.
   • CConfirmPanel: this class show confirm panel.
   • CHero: this class manages the bunnies.
   • CCreditsPanel: this class show credits panel
   • CItem: this class manages the egg.
   • CBonus: this class manages the bonus item.
   • CHelp: this class show help.
   • CLevelBut: this class manages the button level.
   • CLevelMenu: this class show level menu.
   • CBonus: this class manages the bonus.
   • CConfirmPanel: this class show confirm panel.
   • CLifeBoard: this class show life board.
   • CObstacle: this class manages obstacle
   • CPause: this class show pause.
   • CPhysicsController: this class manages the physic world.
   • CPhysicsObject: this class manage the physic object.
   • CScoreBoard: this class show score board.
   • CSideWall: this class manages the side wall.
   • CWinPanel: this class show the win panel.
   • platform: this class utils detect device platform.
   • sprintf: class utils texts
   • CGUIExpandible: this class manages button group
   • CCTLText: this class manages text format
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" and "/sounds" folder are loaded, the main class removes the preloader and calls the CMenu.js file that shows the main menu
4. If the user click the Play button in main menu, the CLevelMenu.js class is called and show levels to choose
5. If the user click on a Level button in level menu, the CGame.js class is called and game starts
6. 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.
• createField()
  This function creates a field collision on sides.
• createLevel()
  This function creates the level from the json file.
• createBonus()
  This function creates a bonus randomly by a occurence array.
• nextLevel()
  This function is called when a game level is completed.
• eggOnFloor()
  This function is called when the egg fall on sand.
• unload
  This function is called when user want to exit from the game.
• gameOver()
  This function is called when game is over.
• 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

---