“FreeCell Solitaire” Documentation by “Code This Lab S.r.l.” v1.0
“FreeCell Solitaire”
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 Card Set
- Disable Sounds
- Wordpress Plugin
A) Description - top
FreeCell Solitaire is a HTML5 Game. Enjoy this stylish version of the classic FreeCell Solitaire!
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 game 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) {
//alert("iScore: "+iScore);
});
});
Localization: You can easily change game text for different languages, changing string in CLang.js
TEXT_GAMEOVER = "YOU WIN";
TEXT_SCORE = "SCORE";
TEXT_MOVES = "MOVES";
TEXT_SCORE = "SCORE";
TEXT_HELP1 = "THE CARD PILES IN BOARD, CAN BE BUILD DOWN BY DECRESCENT CARD RANK WITH ALTERNATE COLORS";
TEXT_HELP2 = "YOU CAN USE A FREE CELL, TO TEMPORARILY DISCARD A CARD. ANYWAY THIS WILL REDUCE THE NUMBER OF CARDS YOU CAN DRAG SIMULTANEOUSLY";
TEXT_HELP3 = "THE GOAL IS TO BUILD UP FOUR FOUNDATIONS BY SUIT, FROM ACE TO KING ";
TEXT_HINT = "NOT ENOUGH EMPTY FREE CELLS. NOW YOU CAN MOVE JUST ";
TEXT_HINT2 = " AT ONCE";
TEXT_HINT_MOVE = "NO MORE MOVES AVAILABLES. RESTART THE GAME.";
TEXT_HELP1_PAGE2 = "SCORE SYSTEM";
TEXT_HELP2_PAGE2 = "You start with ";
TEXT_HELP3_PAGE2 = " points";
TEXT_LOSE1_PAGE2 = "Every time you move a card from its position you lose ";
TEXT_LOSE2_PAGE2 = " point!! Try to complete the game with as few moves as possible!";
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({
points_to_lose: 1, //Number of losing points per move
starting_points: 500, //Points when game starts.
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 8 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 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
- 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
- CEndPanel: the final game over panel
- CHelpPanel: the help panel that is shown before game starting
- CCard: this class manages the card object
- CScore: this class manages the score text that appears when the player gain or lose some points
- 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" 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 CModeMenu.js class is called and the player can choose Difficulty Mode
- When the user choose in Mode Panel, the CGame.js class is called and the game starts
- The User play the game
- If the player clear the board, the game calls the Win Panel
- If the 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 function attach on the canvas some game sprites like background (oBg), GUI and initialize the touch events..
- _shuffleCard()
This function simply shuffles tha card deck.
- _setBoard()
This function init the starting card displacement and card deck.
- pickCard()
This function is called when the player click a card to move.
- dragCard
This function manages the card dragging for Desktop.
- releaseCard()
This function is called when the card is released.
- _checkCardCollision
This function checks if a dragged card can be placed under a card pile.
- _checkFreeCellCollision
This function checks if a dragged card can be placed in free cells.
- _checkSuitCollision
This function checks if a dragged card can be placed in suit foundations.
- _controlBoard
This function checks if game ends, if multiple dragging is possible and if there are more moves available.
- onTouchMove
This function manages the card dragging for mobile(IOS and Android).
- onTouchMoveMS
This function manages the card dragging for Windows Phone mobile.
- _update
This function manages the main game loop.
H) Change Card Set - top
The game contains the card spritesheets that you can edit if you want to change card images.
Currently each card has following dimensions: 79x121. So if you change card size, be sure to change also card setting in settings.js file.
- cards.png: If you want to change card graphic please respect symbols and value disposition.
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