“Ahoy! Pirates Adventure” Documentation by “Code This Lab S.r.l.” v1.0

---

“Ahoy! Pirates Adventure”

---

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

Ahoy! Pirates Adventure is a HTML5 Arcade Game. Are you nostalgic for the classical Pac-Man? Then Ahoy! Pirates Adventure is just right for you!
Help your hero to collect all the gold coins, avoid the mean sentries and use the saber and the TNT to get rid of them!

The ZIP package contains the game with 960x1440 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_SCORE = "SCORE";
					TEXT_SCORE_CASE = "Score";
					TEXT_SCORE_GAMEOVER = "Total Score";
					TEXT_LEVEL = "Level";
					TEXT_LEVEL_UPPERCASE = "LEVEL";
					TEXT_GAMEOVER = "GAME OVER";
					TEXT_COMPLETE = "Complete";
					TEXT_GAME_COMPLETED = "GAME COMPLETED";
					TEXT_HOW_TO_PLAY="HOW TO PLAY";
					TEXT_HELP_PAGE_1_PC = "Use the arrow keys to move your character!";
					TEXT_HELP_PAGE_1_MOBILE = "Swipe your finger to control the character!";
					TEXT_HELP_ENEMY="Escape from him";
					TEXT_SELECT_A_LEVEL="SELECT A LEVEL";
					TEXT_PAUSE="Pause";
					TEXT_HELP_TNT="Touch this to trigger an explosion";
					TEXT_HELP_COIN_PART1="Collect all coins to complete the level and earn 100 PT for each one";
					TEXT_HELP_COIN_PART2="PT every coin";
					TEXT_HELP_SWORD="Take this to get rid of all enemies";
					TEXT_TITLE = "AHOY!!!";
					TEXT_FINAL_SCORE = "FINAL SCORE";
					TEXT_YOU_ARE_DEAD = "YOU'RE DEAD";
					TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";

					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({
					character_speed: 5, //SPEED OF CHARACTER IN MILLISECONDS
					enemy_speed: [1000], //SPEED OF ENEMIES IN MILLISECONDS (FIRST NUMBER, TYPE 0)
					life_character: 2, //START LIFE OF CHARACTER
					coin_score: 100, //ADD THIS VALUE TO SCORE WHEN A COIN IS TAKEN
					time_bonus_attack: 10, // DURATION OF BONUS ATTACK OF CHARACTER
					score_kill_enemy: [200, 400, 800, 1600], // SCORE COMBO GET KILLING A ENEMY
					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
					num_levels_for_ads: 3 //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
   • CCell: this class manages the cell of a matrix
   • CCharacter: this class manages the character.
   • CEnemy: this class manages the enemy.
   • CFloor: this class manages the floor.
   • CLevelBut: this class manages the level button
   • CLevelMenu: this class manages the level menu.
   • easystar-0.2.3.min: this class manages pathfinding for enemies.
   • floor_settings: Diagram floors of levels.
   • hammer.min: this class manages the mobile controls.
   • objects_settings: Diagram objects of levels.
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 the avaible levels
5. If the user click 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.
• setLevelFloor()
  This function creates the floor based on a matrix.
• setLevelObject()
  This function creates a object based on a matrix.
• nextLevel()
  This function is called when the level is over.
• enemyAI()
  This function manages the enemies AI.
• addEffectScore()
  This function attach some graphical effect when enemy is hit.
• unload()
  This function is called when user want to exit from the game.
• restartLevel()
  This function is called when the character die.
• manageObjects()
  This function is called every update for detect a collision between character and a item or trap.
• 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

---