“Whotan The barbarian” Documentation by “Code This Lab S.r.l.” v1.0

---

“Whotan The barbarian”

---

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

Wothan The Barbarian is a HTML Arcade Game. Help your hero to run away from the castle dungeon! But be careful to the many lurking dangers that will threaten him!

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

					TEXT_GAMEOVER  = "GAME OVER";
					TEXT_SCORE     = "YOUR SCORE IS: ";

					TEXT_CREDITS_DEVELOPED = "Developed by";
					TEXT_LINK1 = "www.codethislab.com";

					TEXT_DESKTOP = "RUN ALONG THE PLATFORMS TO ESCAPE FROM THE DOUNGEON! USE LEFT AND RIGHT KEYS TO MOVE YOUR HERO.";
					TEXT_MOBILE = "RUN ALONG THE PLATFORMS TO ESCAPE FROM THE DOUNGEON! USE LEFT AND RIGHT BUTTONS TO MOVE YOUR HERO.";

					TEXT_SLOW_DOWN = "SLOW DOWN PLATFORM!";
					TEXT_HAMMER    = "DESTROY PLATFORM WITH YOUR HAMMER!";

					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({
                                            player_spd: 15,                          //player speed
                                            player_spd_falling: 13,                  //player speed when falling
                                            player_max_spd_falling: 20,              //player speed when falling
                                            player_acceleration_x: 2.8,              //the accelleration to multiply to the velocity to the player when there is no giroscope on device
                                            player_acceleration_y: 0.2,              //accelleration multiplier on y                                 
                                            player_deceleration: 1.2,                //decelleration to add to the player in way to reach the player_spd_min
                                            object_spd: -5,                          //speed of the object (when they are going to move vertically)
                                            object_spd_adder: -0.5,                  //speed adde of the objects (BGs, platform, bonusses
                                            score_to_reach_for_increment_speed: 500, //score to reach to increment speed
                                            object_spd_orizzontal: 4,                //speed of the object (when they are going to move orizontally)
                                            gamma_range_accepted: 4,                 //maxinum gamma read from the game, the more it is, the more the game is difficult (if there is a giroscope)
                                            canvas_half_width_range_accepted: 215,   //cursor range accepted (calculated by the half measure of the canvas width +- this value), if there is no giroscope
                                            height_between_object: 200,              //distance from a platform to another
                                            time_to_spawn_thorns: 2000,              //time delay to spawn the thorns on the platform
                                            time_to_hide_thorns: 1000,               //time delay to hide the thorns on the platform
                                            bonus_occur: 10,                         //value from 0 to 100, increase this value to increase the occurrence of bonus
                                            time_slow_down_powerup: 5000,            //time for the slow down power up
                                            score_breaked_platform: 10,              //score to add for each platform broken
                                            score_to_change_occurrence: 500,         //at this score value there will be available all the platforms
                                            spawn_delay_platform_obstacles: 2,        //each 'value' try spawn a platform with obstacles on it
                                            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:false //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
   • 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
   • CBonus: this class manages the bonusses
   • CCeiling: this class spawn the ceiling on top of the game
   • CCreditsPanel: this class shows the credits panel
   • CEndPanel: this class shows game over panel
   • CFormatText: this class manages the text on "CCreditsPanel"
   • CHelp: this class shows the Help Panel
   • CObstacle: this class manages the obstacles on the platforms
   • CPlatform: this class manages the Platforms
   • CPlayer: this class manages the Player
   • CScrollingBg: this class manages the BackGrounds movement
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 CHelp.js is called, after that the CGame.js class is called and game starts
5. 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.
• _controlIfAllReady()
  This function crontrols if it was preloaded all the platforms in the init.
• _createRow()
  This function creates a platform and checks if can generate a bonus.
• getFirstAvailableObstacle(iType)
  This function gets the first platform free of 'iType' type.
• spawnThorns()
  This function spawns the thorns on the platforms who have that.
• moveObject()
  This function moves the objects (platforms, BGs, ...).
• 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

---