“Gems Glow” Documentation by “Code This Lab S.r.l.” v1.0
“Gems Glow”
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
- Description
- Folder Content
- Getting Started
- HTML Structure
- CSS Files and Structure
- Source Code
- Game functions
- Change Graphic
- Edit a Level
- Disable Sounds
- Wordpress Plugin
A) Description - top
Gems Glow is a HTML5 puzzle game. Connect all the gems of the same color and cover the entire board to solve each level
The ZIP package contains the game with 640x960 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 Enable 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
- 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).
- game
This folder contains the full game source code ready to be edited.
- 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.
- readme
This folder contains the package instructions.
- 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 i-frame.
In the first case the game will fit the screen size, in the second, that of the i-frame.
If the i-frame 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_SELECT_DIFFICULTY = "SELECT DIFFICULTY";
TEXT_SELECT_LEVEL = "SELECT LEVEL";
TEXT_LEVEL = "LEVEL";
TEXT_LEVEL_COMPLETED = "LEVEL COMPLETED!";
TEXT_WIN1 = "CONGRATULATIONS!";
TEXT_WIN2 = "YOU HAVE COMPLETED ALL THE LEVELS!";
TEXT_HELP = "CONNECT MATCHING GEMS AND COVER THE ENTIRE BOARD TO SOLVE EACH LEVEL";
TEXT_HELP_TITLE = "HOW TO PLAY";
TEXT_SCORE = "YOUR SCORE IS: ";
TEXT_MOVES = "MOVES";
TEXT_DEVELOPED = "DEVELOPED BY";
TEXT_DELETE = "THIS WILL DELETE ALL YOUR PROGRESS, ARE YOU SURE?";
TEXT_IOS_PRIVATE = 'Your web browser does not support storing settings locally. In Safari, the most common cause of this is using "Private Browsing Mode". Some info may not save or some features may not work properly';
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({
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
score_to_add: 10, //POINTS TO ADD
score_to_subtract: 5 //POINTS TO SUBTRACT WHEN EXCEEDING MAX NUM MOVES
});
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) Source Code - top
This game contains:
- jQuery
- Our custom scripts
- CreateJs plugin
- Howler plugin
- Screenfull plugin
- jQuery is a Javascript library that greatly reduces the amount of code that you must write.
- 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
- CLevelMenu: this class shows the panel where the user can select a level
- CLevelBut: this class manages the level button in level selection panel
- 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 into the grid
- CEndPanel: this class shows the 'end level' panel.
- CScrollingBg: this class manages scrolling items in the background.
- CHelpPanel: the help panel that is shown before game starting
- CLocalStorage: this class manages game savings
- CModeMenu: this class manages level difficulty selection
- CMsgBox: this class shows a generic message panel
- levelsettings: this class manages all levels information. Use it to customize the levels
- CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
- Howler.js is a suite that manages the sounds
- Screenfull.js manages the fullscreen functionality
Resuming, the complete game flow is the following:
- The index.html file calls the CMain.js file after ready event is called
- The main class calls CPreloader.js to init preloader text and start sprite loading
- 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
- If the user click the Play button in main menu, the level selection panel is shown
- After level selection, the CGame.js class is called and game starts
- If the user click on the exit button in the down-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 function attach on the canvas some game sprites like background (oBg)and the GUI.
- onCellClick()
This function is called when user click on cell.
- onMouseMove()
This function is called when user move the mouse while left button is pressed.
- releaseForm()
This function is called when the user release mouse button.
- getCellPositionInArray()
This function provide an object that is useful to keep coherence of flower lines when user click on a not-empty cell.
- checkIfLevelCompleted()
This function check if level is complete.
- unload
This function is called when user want to exit from the game.
- endPanel()
This function is called when game is over.
- update()
This function manages the main game loop.
G) 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.
G) Edit a Level - top
You can edit pre-existing levels in levelsettings.js file. Each level is declared by this object:
{
"dim" : 5,
"maxMoves": 20,
"diff": 0,
"points" : [
{
"start_r" : 0, "start_c" : 0, "end_r" : 1, "end_c" : 1, "color" : "orange"
},
{
"start_r" : 2, "start_c" : 1, "end_r" : 4, "end_c" : 4, "color" : "green"
},
{
"start_r" : 0, "start_c" : 4, "end_r" : 2, "end_c" : 3, "color" : "yellow"
},
{
"start_r" : 1, "start_c" : 4, "end_r" : 3, "end_c" : 3, "color" : "red"
},
{
"start_r" : 0, "start_c" : 1, "end_r" : 3, "end_c" : 1, "color" : "blue"
}
]
}
- dim is the grid squared size
- maxMoves is the minimum number of moves that user need to complete the level successfully. This parameter is useful to calculate correctly the level score
- dim is the level difficulty classification. Use it to insert the level in the relative difficulty
- points defines 5 values:
- start_r is the row index of a flower 1 in the grid
- start_c is the column index of a flower 1 in the grid
- end_r is the row index of a flower 2 in the grid
- end_c is the column index of a flower 2 in the grid
- color is the flower color
H) 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;
I) 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