“The Stone of the Pharaoh” Documentation by “Code This Lab S.r.l.” v1.0


“The Stone of the Pharaoh”

Created: 21/01/2014
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. Getting Started
  3. HTML Structure
  4. CSS Files and Structure
  5. JavaScript
  6. Game functions
  7. Asset Files
  8. Spritesheets
  9. Change Graphic
  10. Disable Sounds
  11. Wordpress Plugin

A) Description - top

The Stone of the Pharaoh is a HTML5 puzzle game. The goal of the game is to clear all the grid, matching two or more block of the same color. The user loses a life if a single block is clicked.
The ZIP package contains the game with 768x1500 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) Getting Started - top

To install the game just upload on your server the game resolution you need. You can choose among 320x480,320x568 or 768x1024.


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

			
				  
				  
				 
			
		

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


E) 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 game sounds, 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 play button
    • CGfxButton: this class create a standard button
    • CTextButton: this class create a standard text button
    • CToggle: this class create a standard toggle button
    • CHelpPanel: this class manages the help panel that appears when game starts
    • CGame: this class manages the game logic
    • CBoardElem this class controls the grid blocks
    • CInterface: this class controls game GUI that contains text and buttons
    • CEndPanel: this class controls the game over panel that appears when player lose all the lives
    • CMovingElem: this class controls the blocks that move down or right when a user destroy some blocks
    • CTweenController: this class manages the block movement with easings
  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 and sounds are loaded, the main class removes the preloader and calls the CMenu.js file that shows the main menu
  4. If user click on the play button in main menu, the CGame.js class is called and the game starts
  5. The game class shows immediately a help screen that explain briefly the game instructions. When user click on this panel, the game finally starts
  6. When all lives are lost, the game shows a Game Over panel with the final score.
  7. If user click on game over panel, the game returns to the menu screen

F) Game functions - top

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


G) Asset Files - top

The package includes 3 .psd (Photoshop):

  1. blocks_38x38.psd: the spritesheet of blocks
  2. game_768x1500.psd: game layer
  3. hover_38x38.fla: selection of blocks when mouse is over

H) Spritesheet - top

The game contains the block spritesheet that you can edit if you want to change the graphic:

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