“The Gold Miner” Documentation by “Code This Lab S.r.l.” v1.0
“The Gold Miner”
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
- JavaScript
- Game functions
- Change Graphic
- Disable Sounds
- Wordpress Plugin
A) Description - top
The Gold Miner is a HTML5 puzzle game. The goal of the game is to collect all nuggets and diamonds in the level and avoid dynamites.
The ZIP package contains the game with 1600x768 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
- 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 folder live_demo.
- 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:
$(window).ready(function() {
/*if(isIOS()){
setTimeout(function(){sizeHandler();},200);
}else{
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 CMain();
$(oMain).on("save_score", function(evt,iScore) {
//ADD YOUR CODE HERE
});
});
Localization: You can easily change game text for different languages, changing string in CLang.js
TEXT_SCORE = "SCORE";
TEXT_LEVEL = "LEVEL";
TEXT_GAME_OVER = "GAME OVER";
TEXT_WIN = "CONGRATULATIONS";
TEXT_TARGET = "TARGET";
TEXT_COLLECT = "COLLECT";
TEXT_AVOID = "AVOID";
TEXT_PLAY = "PLAY";
TEXT_EXIT = "EXIT";
TEXT_PASSED = "PASSED";
var 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({
malus_score: 100, //DOLLARS TO SUBTRACT WHEN PLAYER HIT A DYNAMITE
hook_speed: 15, //STARTING HOOK SPEED
level_time:60000, //LEVEL COUNTDOWN IN MILLISECONDS
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
});
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 stylings for the canvas and some hack to be fully compatible with all most popular mobile devices
F) JavaScript - top
This game contains:
- jQuery
- Our custom scripts
- CreateJs plugin
- Howler Sound library
- 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 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
- CHelp: this class manages the help panel that appears when game starts
- CGame: this class manages the game logic and interface
- CChangeLevel: this class shows the 'next level' panel
- CEndPanel: this class shows the game over and win panels
- CHook: this class manages the hook object
- CLevelSettings: info about level like bonus/malus position and infos
- CMalus: this class manages the dynamite object
- CNugget: this class manages the nugget/diamond object
- CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
- Howler is a javascript Audio library.
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" folder and sounds (if not mobile) are loaded, the main class removes the preloader and calls the CMenu.js file that shows the main menu
- If user click on the play button in main menu, the CGame.js class is called and the game starts
- The game class shows immediately a help screen that explain briefly the game instructions. When user click on this panel, the game finally starts
- If player can't get the target level, the game shows a Game Over panel with the final score. Otherwise game shows the next level
- If user click on game over panel, 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 all game sprites like background (oBg), GUI and help panel. It also init the grid and the "next" panel.
- unload()
This function clear the game canvas when player decides to exit from the game.
- _initNuggets()
This function put all the nugget and dynamites on the level.
- changeLevel()
This function is called when "next level" panel is skipped.
- _checkCollision()
This function manages collision among objects.
- _endLevel()
This function is called when level is cleared.
- update()
This function manages the 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) 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