“Virus Attack” Documentation by “Code This Lab S.r.l.” v1.0

---

“Virus Attack”

---

Table of Contents

1. Description
2. Folder Contents
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

Virus Attack is a HTML5 Arcade Game. Cleam portions of screen weaving lines, but be careful! A bunch of deadly viruses will try to destroy you and your lines!

The ZIP package contains the game with 640x1024 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_GAMEOVER  = "GAME OVER";
									TEXT_SCORE     = "SCORE";
									TEXT_TOTAL_SCORE = "TOTAL SCORE:";
									TEXT_ARE_SURE = "ARE YOU SURE?";

									TEXT_DEVELOPED = "DEVELOPED BY";
									TEXT_LINK = "www.codethislab.com";

									TEXT_SELECT_WORLD = "SELECT THE WORLD YOU WANT TO PLAY";
									TEXT_SELECT_STAGE = "SELECT THE STAGE";

									TEXT_VIRUS_TYPE = "VIRUS TYPE";
									TEXT_STAGE = "STAGE";

									TEXT_CONGRATULATION = "CONGRATULATIONS!";
									TEXT_DEFEATED = "YOU DEFEATED VIRUS";
									TEXT_INSTAGE = "IN STAGE";

									TEXT_DEFEATED_ALL = "YOU DEFEATED ALL VIRUS!";


									TEXT_HELP1_MOB = "SWIFT ON THE SCREEN TO MOVE YOUR HERO AND WEAVE A LINE";
									TEXT_HELP2_MOB = "TAP ON THE SCREEN TO STOP HERO MOVEMENT";
									TEXT_HELP1     = "USE ARROW KEYS TO MOVE YOUR HERO ALONG THE SIDES OF THE SCREEN";
									TEXT_HELP2     = "PRESS AND HOLD THE SPACE BAR TO WEAVE A LINE";
									TEXT_HELP3     = "CLAIM THE % OF SCREEN SHOWN IN THE BOX TO PASS THE LEVEL";
									TEXT_HELP4     = "WHILE WEAVING, DON'T LET THE VIRUSES CATCHING YOU AND YOUR LINES!";
									var 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_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({

                                                hero_speed: 1, //SPEED OF THE HERO: 1-NORMAL SPEED, 2-FAST SPEED, 3-SUPER SPEED. NO OTHER VALUE ARE ALLOWED
                                            hero_starting_life: 4, //STARTING LIFE PER STAGE OF THE HERO    
                                            
                                            win_quote : [   //WIN QUOTE TO REACH, IN ORDER TO WIN A STAGE
                                                75,     //VIRUS 1
                                                80,     //VIRUS 2
                                                85,     //VIRUS 3
                                                90      //VIRUS 4
                                            ],
                                            
                                            virus_speed: [   //GENERAL SPEED OF VIRUSES
                                                //VIRUS 1
                                                4,  //STAGE 1
                                                6,  //STAGE 2
                                                8,  //STAGE 3
                                                //VIRUS 2
                                                4,  //STAGE 1
                                                5,  //STAGE 2
                                                6,  //STAGE 3
                                                //VIRUS 3
                                                4,  //STAGE 1
                                                5,  //STAGE 2
                                                6,  //STAGE 3
                                                //VIRUS 4
                                                3,  //STAGE 1
                                                4,  //STAGE 2
                                                5   //STAGE 3                                                
                                            ],
                                            
                                            max_num_minions_spawn: [    //MAX NUMBER OF MINION SPAWNED BY A BOSS
                                                //VIRUS 1
                                                10,  //STAGE 1
                                                12,  //STAGE 2
                                                8,  //STAGE 3
                                                //VIRUS 2
                                                10,  //STAGE 1
                                                9,  //STAGE 2
                                                8,  //STAGE 3
                                                //VIRUS 3
                                                10,  //STAGE 1
                                                12,  //STAGE 2
                                                8,  //STAGE 3
                                                //VIRUS 4
                                                12,  //STAGE 1
                                                11,  //STAGE 2
                                                9   //STAGE 3                                                
                                            ],
                                            
                                            minion_killed_score: 500,    //SCORE FOR A MINION KILL
                                            
                                            score_star_earned: [   ////SCORE TOTALIZED TO EARN A STAR AFTER COMPLETE A STAGE
                                                1,      //FIRST STAR
                                                3000,   //SECOND STAR
                                                6000    //THIRD STAR
                                            ],
                                            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    
                                           });
				

---

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
   • CGame: this class manages the game logic
   • CInterface: this class controls game GUI that contains text and buttons
   • CAreYouSurePanel: this class ensure the confirm to exit from game
   • CLocalStorage: this class controls persistent data storage
   • CCreditsPanel: this class shows developers credits
   • CHelpPanel: this class shows how-to play the game
   • CEndPanel: this class shows lose game summary
   • CVector2: this class contain vector math operation
   • CTweenController: this class controls tween movement interpolation
   • CCongratulationPanel: this class shows end of the game summary
   • CAnimation: this class controls ingame animations
   • CBorder: class of the border game object
   • CController: this class manages all movement control operations
   • CHero: this class manage the main character behaviour
   • CLevelButton: this class create a level button
   • CLevelMenu: this class manage level menu selection
   • CNextLevelPanel: this class shows end of a stage summary
   • CScoreAnim: score animations class
   • CVirus: this class manages viruses character behaviour
   • CVirusSettings: global settings of viruses
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 for level selection is shown
5. After level selection, the CGame.js class is called and game starts
6. 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.
• _setLevel()
  This function set main elements of the game, like viruses and their behaviour.
• _setLevel()
  This function set main elements of the game, like viruses and their behaviour.
• _spawnInterval()
  This function set spawn interval of the minions.
• restartGame()
  This function restart the level of the game.
• checkClosedElements()
  This function manage border quote and check if you have enough quote to finish the stage and minion killed in your weave.
• _checkCollision()
  This function check collision between viruses and main character.
• 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

---