HTML5 Jacks or Better

### “HTML5 Jacks or Better” Documentation by “Code This Lab S.r.l.” v1.0

# “HTML5 Jacks or Better”

Created: 28/11/2014
By: Code This Lab S.r.l.
Email: info@codethislab.com

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

1. Description
2. Folder Content
3. Getting Started
4. HTML Structure
5. CSS Files and Structure
6. JavaScript
7. Game functions
8. Change Card Set
9. Disable Sounds
10. Wordpress Plugin

### A) Description - top

Jacks or Better is a HTML5 casino game. Enjoy this videopoker game with the stylish graphic!
The ZIP package contains the game with 1920x768 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

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 game folder live_demo.

- 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 CMain();

      							$(oMain).on("end_hand", function(evt,iMoney,iWin) {
                                   //alert("iMoney: "+iMoney +" WIN: "+iWin);
                           });
      						});

- Recharge Money: When user finishes his credit, you can recharge money adding your own php function in "recharge" call in index.html file:

      						$(oMain).on("recharge", function(evt) {
      								 yourPhpFunction();
      						 });

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

    					TEXT_GAMEOVER  = "GAME OVER";
    					TEXT_PLAY      = "PLAY";
    					TEXT_BET       = "BET";
    					TEXT_WIN       = "WIN";
    					TEXT_MONEY     = "MONEY";
    					TEXT_DEAL      = "DEAL";
    					TEXT_BET_ONE   = "BET ONE";
    					TEXT_MAX_BET   = "BET MAX";
    					TEXT_RECHARGE  = "RECHARGE";
    					TEXT_EXIT      = "EXIT";
    					TEXT_DRAW      = "DRAW";
    					TEXT_NO_WIN    = "NO WIN";
    					TEXT_CURRENCY  = "$";
    					TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";
    					TEXT_COMBO     = new Array(
    												"Royal Flush",
    												"Straight Flush",
    												"Four of a Kind",
    												"Full House",
    												"Flush",
    												"Straight",
    												"Three of a Kind",
    												"Two Pairs",
    												"Jacks or Better"
    												)

    					TEXT_CONGRATULATIONS = "Congratulations!";
    					TEXT_SHARE_1 = "You collected "
    					TEXT_SHARE_2 = " points!

    Share your score with your friends!";
    					TEXT_SHARE_3 = "My score is ";
    					TEXT_SHARE_4 = " 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({
                                        win_occurrence: 40,                    //WIN OCCURRENCE PERCENTAGE
                                        game_cash: 100,                        //MONEY IN GAME CASH. IF THE GAME DOESN'T HAVE ENOUGHT MONEY, THE PLAYER MUST LOSE.
                                        bets: [0.2,0.3,0.5,1,2,3,5],           //ALL THE AVAILABLE BETS FOR THE PLAYER
                                        combo_prizes: [250,50,25,9,6,4,3,2,1], //WINS FOR FIRST COLUMN
                                        money: 100,                            //STARING CREDIT FOR THE USER
                                        recharge:true,                         //RECHARGE WHEN MONEY IS ZERO. SET THIS TO FALSE TO AVOID AUTOMATIC RECHARGE
                                        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
                                        show_credits:true,                     //ENABLE/DISABLE CREDITS BUTTON IN THE MAIN SCREEN
                                        num_hand_before_ads:10     //NUMBER OF HANDS PLAYED BEFORE AD SHOWN
                                        //
                                        //// THIS FUNCTIONALITY IS ACTIVATED ONLY WITH CTL ARCADE PLUGIN.///////////////////////////
                                        /////////////////// YOU CAN GET IT AT: /////////////////////////////////////////////////////////
                                        // http://codecanyon.net/item/ctl-arcade-wordpress-plugin/13856421 ///////////
                                    });

### 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 6 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:

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, 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 preloader that shows resources loading progress
   - CMenu: simple menu with a play button
   - CGfxButton: this class create a standard button
   - CTextButton: this class create a standard text button
   - CToggleButton: this class create a toggle button
   - CGame: this class manages the game logic
   - CInterface: this class controls the game GUI that contains text and buttons
   - CCard: this class manage the card object
   - CGameOver: this class manages the game over panel that is shown when the credit is over
   - CGameSettings: this class store all the info about the card deck
   - CHandEvaluator: this class checks if the player has a winning hand
   - CPayTable: this class shows the paytable screen
   - CPayTableSettings: this class stores all the info about paytable
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 resources loading
3. When all resources contained in "/sprites" folder 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 CGame.js class is called and the game starts
5. If the player's credit is over a game over panel is shown
6. 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 function attach on the canvas some game sprites like background (oBg), GUI and paytable.
- unload()
  This function removes all images from canvas and event listeners on buttons. It's called when user decide to exit from the game.
- resetHand()
  This function is called when an hand is over.
- dealCards()
  This function deals the card to the player
- drawCards()
  This function replace the cards not held by the player.

### 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: 154x240. So if you change card size, be sure to change also card setting in settings.js file.

- card_spritesheet.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