“Sweety Mahjong” Documentation by “Code This Lab S.r.l.” v1.0

---

“Sweety Mahjong”

---

Table of Contents

1. Description
2. Getting Started
3. HTML Structure
4. CSS Files and Structure
5. JavaScript
6. Game functions
7. Events
8. Asset Files
9. Change Tiles

---

A) Description - top

Sweety Mahjong is a HTML5 mahjong game. Enjoy this coloroued mahjong game with sweety symbols!
The ZIP package contains the game at 800x600 resolution that automatically scales to fit current screen device and all the assets to grant complete game customization.
The game is fully compatible with all most common mobile devices.

---

B) Getting Started - top

To install the game just upload on your server the folder game. WARNING: The game won't run locally with some browser like Chrome due to some security restrictions.

• Game Resize: All game resolution automatically center itself and fits on the screen thanks to the ctl_utils.js file. If you want to avoid this, comment this function in this way:

					$(window).ready(function() {
						//sizeHandler();
					});
				

• 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 CApp();
  							
  							$(oMain).on("save_score", function(evt,score,bWin) {
  								//ADD YOUR CODE HERE
  							});
  						});
  					

• Localization: You can easily change game text for 7 different languages: ENGLISH (default language), GERMAN, FRENCH, SPANISH, ITALIAN, DUTCH AND PORTUGUESE. To change the game language, edit the file CSettings.js uncommenting the required language

					//ENGLISH
					var LANGUAGE = "en_UK";
					//GERMAN
					//var LANGUAGE = "de_DE";
					//SPANISH
					//var LANGUAGE = "es_ES";
					//FRENCH
					//var LANGUAGE = "fr_FR";
					//ITALIAN
					//var LANGUAGE = "it_IT";
					//DUTCH
					//var LANGUAGE = "nl_NL";
					//PORTUGUESE
					//var LANGUAGE = "pt_PT";
					

• Game option: You can easily customize some game setting editing the CSettings.js file

					var BONUS_TIME = 12000; //BONUS TIME IN MILLISECONDS. USER HAVE 12 SECONDS TO MATCH NEW PAIRS AND GET BONUS SCORE.
					var HINT_PENALTY = 10;  //POINTS THAT USER LOST WHEN CLICK ON HINT BUTTON
					var SCORE_BONUS_LAYOUT_EASY   = 1; //SCORE MULTIPLIER FOR LAYOUT EASY
					var SCORE_BONUS_LAYOUT_MEDIUM = 2; //SCORE MULTIPLIER FOR LAYOUT MEDIUM
					var SCORE_BONUS_LAYOUT_HARD   = 3; //SCORE MULTIPLIER FOR LAYOUT HARD
				

---

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: CApp().
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 3 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 game panels

---

E) JavaScript - top

This game contains:

1. jQuery
2. Our custom scripts

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:
   • CApp: the main class called by the index file.
     This file controls the sprite_lib.js file that manages the sprite loading, init the language and the message box
   • ctl_utils: this file manages the canvas resize and its centering
   • sprite_lib: this class loads all images declared in the main class
   • CSettings: general game settings
   • CMsgBox: this class manages the Message Box that appear when user want to exit from game
   • CLang: global string variables for language localization
   • CMenu: simple menu with play and help button
   • CMenuLayout: layout menu that contains the layout buttons
   • CLayoutButton: this class manages the button in layout panel
   • CHelp: this class manages the help panel
   • CGame: this class manages the game logic
   • CTile: this class manages the tiles
   • CInterface: this class controls game GUI that contains text and buttons
   • CGameOverPanel: this class controls the game over panel that appears when there are no more selectable tiles
   • CWinPanel: this class controls the win panel that appears when layout is completely cleared

Resuming, the complete game flow is the following:

1. The index.html file calls the CApp.js file after load event is called
2. The main class calls function _loadImages to start sprite loading
3. When all sprites contained in "/css/skins/" folder are loaded, the main class 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 User can win (clearing completely the game layout) or lose ( no more tiles selectable)
6. If user click on the exit button in the up-right corner, 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.

• _init()
  This is the first function called in the class. It set the choosen layout and init the GUI.
• _initTilesOnBoard()
  This function draw all tiles for the selected layout.
• _storeSelectableTiles()
  This function check if there are selectable tiles and refresh available couple counter.
• removeHint()
  This function is called when user click on two tiles that are in hint state.
• _checkTileMatching()
  This function verify if user clicked two tiles with the same symbols.
• onRestartBoard()
  This function is called when user click the restart button.
• onShuffleBoard()
  This function is called when user click the shuffle button.
• onTileSelected()
  This function is called when user click a tile.
• _update()
  This function is the main game loop.

---

G) Events - top

The game trigger the following events:

• game_start: this event is called when user click play button in the main menu.
• save_score: this event is called each time user win or lose the game. It passes the current score and final game state (win or lose).
• restart: this event is called when user exit from the game

---

H) Asset Files - top

The game package contains a psd (Photoshop) file with all game tiles .

---

I) Change Tiles - top

The game contains all tiles png in the folder css/skins/sweety/
You can use tiles.psd file to change tile artwork.

• some tiles visible in game:

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

---