“King Bacon vs Vegans” Documentation by “Code This Lab S.r.l.” v1.0


“King Bacon vs Vegans”

Created: 18/04/2017
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. Edit Enemy and Level Settings
  5. HTML Structure
  6. CSS Files and Structure
  7. Source Code
  8. Game functions
  9. Change Graphic
  10. Disable Sounds
  11. Wordpress Plugin

A) Description - top

In Veganopolis a huge war has just begun! The mean King Bacon and his wicked sidekicks are messing up the city! Destroy'em all! But be careful to not kill the pitiful chickens rushing for safety!

The ZIP package contains the game with 1136x832 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:
  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)Edit Enemy and Level Settings - top

You can set Game difficulty, editing Enemy and Level settings in game_settings.json file.
These parameters manages the enemies, boss and survicors(chicken):

					"character_health":[1,2,1,2,3], //THIS ARRAY INDICATES THE NUMBER OF HIT YOU NEED TO KILL EACH ENEMY. 
													//SO [1,2,1,2,3] MEANS THAT THE FIRST ENEMY (THE POTATO) NEEDS 
													//1 HIT TO BE KILLED, THE SECOND ENEMY ( MEAT BALL) 2 HITS AND SO ON...
					"character_speed":[400,300,200,300,400], //THIS ARRAY INDICATES THE SPEED FOR EACH ENEMY. 
															 //HIGHER IS THE VALUE, SLOWER IS THE ENEMY.
					"character_points":[10,15,20,30,40],//THIS ARRAY INDICATES THE POINTS ASSIGNED BY ENEMY WHEN IS KILLED
					"boss_health":40,                   //NUMBER OF HIT TO KILL FINAL BOSS
					"boss_speed":1500,                  //FINAL BOSS SPEED
					"boss_points":1000,                 //POINTS ASSIGNED WHEN BOSS IS KILLED
					"survivor_health":1,                //NUMBER OF HIT TO KILL A CHICKEN
					"survivor_speed":300,               //CHICKEN SPEED
					"survivor_points":100               //POINTS DECREASED IF CHICKEN IS KILLED
				


Each level can be edited, changing following params:
					{
						"level_num": 1,     //THIS PARAMETER INDICATES THE LEVEL NUMBER
						"num_character":20, //NUMBER OF ENEMIES FOR CURRENT LEVEL
						"num_survivor":0,   //NUMBER OF CHICKENS IN CURRENT LEVEL
						"character_occur":[50,50,0,0,0], //THIS ARRAY INDICATES THE ENEMY OCCURRENCE. IN THIS EXAMPLE THERE IS 50% OF SPAWNING ENEMY 1, 50% ENEMY 2, 0% OTHERS
						"character_time_spawn_interval":1500, //TIME INTERVAL FOT NEXT ENEMY SPAWN
						"perc_enemy_to_kill_per_stars":[100,95,90], //PERCENTAGE OF ENEMIES TO KILL TO GET 3 STARS (100%), 2 STARTS ( 95%) AND 1 STAR (90% OR LESS) 
						"spawn_boss":false //THIS PARAMETER INDICATES IF BOSS IS PRESENT IN THE CURRENT LEVEL
					}
				

E)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

			
				  
				  
				 
			
		

F) 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


G) 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
    • CEndPanel: this class manages the panel that is shown when the game is over
    • CAreYouSurePanel: this class manages panel that is shown when exit button in game is clicked
    • CBoss: this class manages the boss in level 10
    • CBullet: this class manages the bullet (tomato or melon shot by player)
    • CCharacter: this class manage the enemy character
    • CMsgBox: this class manages message box panel
    • CTweenController: this class manages the object movements
    • CCreditsPanel: this class manage the credit panel
    • CGamesSettings: this class stores all infos about characters in game.
    • CHelpPanel: this class manages the help panel before game starts.
    • CKingGUI: this class manages King sprite in the GUI.
    • CLevelBut: this class manages the level button in the CLevelMenu class.
    • CLevelMenu: this class manages the panel where the user can choose the level.
    • CNextLevel: this class manages the Panel that is shown when level is over.
    • CPause: this class manages the panel that is shown when pause button is clicked.
    • CPlayer: this class manage the player character
    • CPowerUp: this class manages the power-up sprite.
    • CPowerUpMsg: this class manages the message that is shown when the player get a power-up.
    • CScoreText: this class shows the score text that is shown when enemy is killed.
    • CVeganGUI: this class manages vegan sprites in background.
    • CVersusPanel: this class manages versus message that is shown when boss level starts.
    • CWinPanel: this class manages the panel that is shown when the game is won
  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, CLevelMenu class is called and user can choose the level
  5. Once selected a level, 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

H) Game functions - top

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


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

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.

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