“Halloween Memory” Documentation by “Code This Lab S.r.l.” v1.0

---

“Halloween Memory”

---

Table of Contents

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

---

A) Description - top

Halloween Memory is a HTML5 Puzzle game. Match all identical cards before time runs out!
The ZIP package contains the game with 1920x1080 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 .
  
  
• Save Score: if you need to call your php function for saving score, you can add it in the index.html file:

  						$(document).ready(function(){
  							var oMain = new CMain();
  							
  							 $(oMain).on("save_score", function(evt,iScore) {
  								//alert("iScore: "+iScore);
  							});
  						});
  					

• Localization: You can easily change game text for different languages, changing string in CLang.js

					TEXT_GAMEOVER  = "GAME OVER";
					TEXT_PLAY      = "PLAY";
					TEXT_LEVEL_SCORE = "LEVEL SCORE";
					TEXT_LEVELCOMPLETED = "STAGE CLEARED!";
					TEXT_TIMELEFT = "Time ";
					TEXT_SCORE = "Score ";
					TEXT_MATCH_SCORE = "SCORE MATCHING";
					TEXT_TIMEBONUS = "TIME BONUS";
					TEXT_TOTALSCORE = "TOTAL SCORE";
					TEXT_VICTORY = "CONGRATULATIONS!!";
					TEXT_PLAY_AGAIN = "PLAY AGAIN";
					TEXT_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?";
					

• Game option: You can easily customize game setting when creating a new instance of the game in index.html file

					var oMain = new CMain({
												card_per_level : [4,      //NUM CARD IN LEVEL 1
																  8,      //NUM CARD IN LEVEL 2
																  16,     //NUM CARD IN LEVEL 3
																  32      //NUM CARD IN LEVEL 4
																  ],     
												
												time_level:[30,  //NUM SECONDS PER LEVEL 1
															60,  //NUM SECONDS PER LEVEL 2
															120, //NUM SECONDS PER LEVEL 3
															240  //NUM SECONDS PER LEVEL 4
															],
												
												score_match_card: 10,     //SCORE ASSIGNED WHEN USER MATCH TWO CARDS
												score_time_left_mult: 2,  //MULTIPLIER ASSIGNED TO REMAINING LEVEL TIME
												time_match_mult: 3000,     //TIME AVAILABLE BETWEEN DISCOVERED MATCHING TO GET SCORE MULTIPLIER 
												show_cards: 0             //IF YOU WANT TO SHOW CARDS FOR SOME SECONDS WHEN LEVEL START, SET THIS VALUE > 0 (NUM OF SECONDS)
											});
				

---

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 7 mapped events that can be useful eventually for stats

---

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 styles for the canvas and some hack to be fully compatible with all most popular mobile devices

---

F) JavaScript - top

This game contains:

1. jQuery
2. Our custom scripts
3. CreateJs plugin

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
   • CGameOver: the final game over panel
   • CVictory: this panel is shown when user win the game
   • CCard: this class manages the cards
3. CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.

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" folder are loaded, the main class removes the preloader and calls the CMenu.js file that shows the main menu
4. If user click the play button in main menu, the CGame.js class is called and the game starts
5. The User play the game
6. When the level time is over, the game calls the Game Over panel
7. If user click on the exit button in the up-left 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), GUI and create characters grid.
• unload()
  This function removes all images from canvas and event listeners on buttons. It's called when user decide to exit from the game.
• checkMatching()
  This function check if two cards are identical.
• checkVictory()
  This function check if level is complete.
• nextLevel()
  This function is called when start a new level.
• update
  Main game loop.

---

H) Change Cards - top

The game contains the card spritesheet that you can edit if you want to change card images.
Currently each card has following dimensions: 160x252. So if you change card size, be sure to change also card setting in settings.js file.

• card_spritesheet.png: If you want to change card graphic, replace this png with your own.
  
  
  
  

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.

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

---