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

---

“Mahjong Deluxe”

---

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 Graphic
9. Disable Sounds
10. Change Tiles
11. Wordpress Plugin

---

A) Description - top

Mahjong Deluxe is a HTML5 mahjong game. Enjoy this stylish mahjong game with wooden tiles!
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) 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 folder game. WARNING: The game won't run locally with some browser like Chrome due to some security restrictions.

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

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

					var TEXT_GAMEOVER    = "GAME OVER";
					var TEXT_CONGRATS    = "CONGRATULATIONS";
					var TEXT_SCORE       = "SCORE";
					var TEXT_BONUS_TIME  = "BONUS TIME";
					var TEXT_SELECT_LEVEL = "SELECT A LEVEL";
					var TEXT_SHUFFLE = "SHUFFLE";
					var TEXT_RESTART = "RESTART";
					var TEXT_HINT = "HINT";
					var TEXT_ALERT_EXIT = "DO YOU REALLY WANT TO EXIT?";
					var TEXT_ALERT_RESTART = "DO YOU REALLY WANT TO RESTART?";
					var TEXT_ALERT_SHUFFLE = "DO YOU REALLY WANT TO SHUFFLE?";
					var TEXT_FINAL_SCORE = "FINAL SCORE";
					var TEXT_BEST_SCORE = "BEST SCORE";
					var TEXT_NO_TILES = "NO MORE TILES SELECTABLE!";
					var TEXT_NO = "NO";
					var TEXT_YES = "YES";
					var TEXT_EXIT = "EXIT";
					var TEXT_ERR_LS = "YOUR WEB BROWSER DOES NOT SUPPORT STORING SETTING LOCALLY. IN SAFARI, THE MOST COMMON CAUSE OF THIS IS USING 'PRIVATE BROWSING MODE'. SOME INFO MAY NOT SAVE OR SOME FEATURE MAY NOT WORK PROPERLY.";
					var TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";

					var TEXT_SHARE_IMAGE = "200x200.jpg";
					var TEXT_SHARE_TITLE = "Congratulations!";
					var TEXT_SHARE_MSG1 = "You collected ";
					var TEXT_SHARE_MSG2 = " points!

Share your score with your friends!";
					var TEXT_SHARE_SHARE1 = "My score is ";
					var 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({
											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
											bonus_time: 12000,     //SET VALUE (IN MILLISECONDS) FOR BONUS TIME. THE BONUS TIME ASSIGN THE SCORE FOR MATCHING. IF IT IS ZERO, NO SCORE IS ASSIGNED 
											hint_penalty:10        //POINT TO DECREASE IF PLAYER USES AN HINT
                                });
				

---

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 4 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 stylings for the game panels

---

F) JavaScript - 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, 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
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 user click on the play button in main menu, the CMenuLayout.js class is called and the use can choose a layout to play
5. Once user has choosen a layout, game starts.
6. The User can win (clearing completely the game layout) or lose ( no more tiles selectable)
7. If 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 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.

---

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) Change Tiles - top

The game contains a spritesheet of all the tiles in the folder sprites/

You can replace spritesheet artwork in any editing software like Photoshop

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

---