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

---

“Rummy”

---

Table of Contents

1. Description
2. Folder Contents
3. Getting Started
4. HTML Structure
5. CSS Files and Structure
6. Source Code
7. Game functions
8. Change Graphic
9. Disable Sounds
10. Wordpress Plugin

---

A) Description - top

Rummy is a HTML5 Card Game. Enjoy this stylish version of the classic Rummy Card Game!

The ZIP package contains the game with 1920x1920 resolution that scales to fit the whole screen both in portrait and landscape mode
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 Contents - top

The item package contains the following folders:

• ctl_arcade_wp_plugin:
  This folder contains the game version (zip file inside) that can be used with wordpress plugin CTL Arcade
  
  
• game:
  This folder contains the full source code that you can edit as you need.
  
  
• live_demo:
  This folder contains the obfuscated version of the game. WARNING: you should use this version if you don't have to edit the original game.
  
  
• readme:
  This folder contains the readme of the game.

---

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 .
  
  
• Localization: You can easily change game text for different languages, changing string in CLang.js

					var TEXT_PLAYER = "PLAYER";
					var TEXT_WINNER = "WINNER IS";
					var TEXT_NICK = "NICKNAME";
					var TEXT_SCORE = "SCORE";
					var TEXT_WIN = "WIN";
					var TEXT_POINTS = "POINTS";
					var TEXT_CARDS = "CARDS"
					var TEXT_GAME_OVER = "ROUND OVER";
					var TEXT_SELECT_NUM = "SELECT NUMBER OF PLAYERS";
					var TEXT_NO_WASTE = "YOU CAN'T DROP A CARD IN THE WASTE PILE BEFORE GETTING A CARD FROM THE DECK";
					var TEXT_NO_DROP = "YOU CAN'T CREATE A COMBINATION BEFORE GETTING A CARD FROM THE DECK";
					var TEXT_NOT_ENOUGH_POINTS = "NOT ENOUGH POINTS FOR OPENING";
					var TEXT_INVALID_COMBO = "INVALID COMBINATION";
					var TEXT_INVALID_CARD_IN_COMBO = "THIS CARD CAN'T BE USED FOR THIS COMBINATION!";
					var TEXT_CANT_PLACE_CARDS_IF_NOT_OPENING = "CAN'T PLACE ANY CARD BEFORE OPENING. YOU NEED AT LEAST";
					var TEXT_INCOMPLETE_COMBO = "ONE OF YOUR COMBINATION ON THE TABLE IS INCOMPLETE. DO YOU WANT TO REMOVE IT?";
					var TEXT_REMOVE_COMBO = "DO YOU WANT TO REMOVE THIS COMBO?";
					var TEXT_CANT_DISCARD_WASTE_CARD = "YOU CAN'T DISCARD A CARD YOU PICKED FROM THE WASTE PILE PREVIOUSLY";
					var TEXT_PRELOADER_CONTINUE = "START";
					var TEXT_DOUBLE = "DOUBLE SCORE";
					var TEXT_ARE_YOU_SURE = "ARE YOU SURE?";

					var TEXT_HELP_WASTE = "DISCARD A CARD IN THE WASTE PILE!";
					var TEXT_HELP_TITLE = ["RULES","STOCK PILE","MELDS","SCORING"];
					var TEXT_TRIS = "TRIS";
					var TEXT_POKER = "POKER";
					var TEXT_STRAIGHT = "STRAIGHT";
					var TEXT_HELP_0 = "RUMMY IS A CARD GAME WHERE THE AIM IS TO PUT ALL YOUR CARDS INTO COMBINATION BEFORE YOUR OPPONENTS. WHEN THE GAME STARTS, EACH PLAYER RECEIVES ";
					var TEXT_HELP_1 = "ONCE ALL CARDS ARE DEALED TO ALL THE PLAYERS, THE REMAINING CARDS ARE PLACED FACE DOWN ON THE TABLE, FORMING THE STOCK.THE TOP CARD IS TURNED UPWARD IN THE WASTE PILE.";
					var TEXT_HELP_2 = "EACH TURN, THE CURRENT PLAYER CAN CHOOSE TO PICK UP THE CARD FROM THE WASTE PILE OR FROM THE STOCK.";
					var TEXT_HELP_3 = "THE PLAYER CHECKS IF HE CAN PLACE ON THE TABLE ONE OR MORE COMBINATIONS OR JUST DISCARD A CARD FROM HIS OWN HAND";
					var TEXT_HELP_4 = "WHEN A PLAYER PLACES ALL THE CARDS, HE WINS THE ROUND. THE WINNING SCORE IS THE SUM OF THE CARD RANKS OF ALL THE OPPONENTS. FACE CARDS COUNT 10 EACH, ACES";
					var TEXT_HELP_5 = "EACH, AND EVERY OTHER CARD THEIR VALUE."
					var TEXT_HELP_6 = "THE FIRST PLAYER THAT REACHES THE SCORE OF";
					var TEXT_HELP_7 = "WINS THE GAME!";
					var TEXT_HELP_8 = "YOU CAN START PLACING CARDS ONLY ONCE THE SUM OF THE CARD RANKS IS AT LEAST "; 
					var TEXT_HELP_9 = "IF THE WINNER PLACES ALL CARDS IN 1 TURN, HE DOUBLES THE POINTS!"; 
					var TEXT_DEVELOPED = "DEVELOPED BY";
					var TEXT_ERR_LS = "YOUR WEB BROWSER DOES NOT SUPPORT LOCAL STORAGE. IF YOU'RE USING SAFARI, IT MAY BE RELATED TO PRIVATE BROWSING. AS A RESULT, SOME INFO MAY NOT BE SAVED OR SOME FEATURES MAY NOT BE AVAILABLE.";

					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";
				

---

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

Game option: You can easily customize game setting when creating a new instance of the game in index.html file

					var oMain = new CMain({
												num_cards_for_2_players:10,  //NUMBER OF CARD TO DEAL FOR EACH PLAYER WHEN THERE ARE 2 PLAYERS. DEFAULT IS 10.MIN VALUE IS 4. MAXIMUM VALUE IS 13.
                                                num_cards_for_3_players:7,  //NUMBER OF CARD TO DEAL FOR EACH PLAYER WHEN THERE ARE 3 PLAYERS. DEFAULT IS 10.MIN VALUE IS 4. MAXIMUM VALUE IS 13.
                                                num_cards_for_4_players:7,  //NUMBER OF CARD TO DEAL FOR EACH PLAYER WHEN THERE ARE 4 PLAYERS. DEFAULT IS 10.MIN VALUE IS 4. MAXIMUM VALUE IS 13.
                                                
                                                min_point_for_opening:0,   //WHEN USER WANT TO START MELDING CARDS ON THE TABLE, THE SUM OF THE COMBOS MUST BE THIS VALUE OR MORE
                                                joker_available:false,      //SET IF JOKER ARE AVAILABLE IN THE STARTING DECK OR NOT.
                                                ace_high:true,             //SET THIS VALUE = TRUE TO ALLOW THE STRAIGHT: QUEEN, KING, ACE (Q K A).
                                                going_rummy_rule:true,     //SET 'GOING RUMMY' RULE ACTIVE/DISACTIVE. IF ACTIVE, A PLAYER THAT LAYS OFF ALL THEIR ENTIRE HAND IN A SINGLE TURN,
                                                                           //GET A DOUBLED SCORE FROM THE OTHER PLAYERS
                                                
                                                score_to_reach_for_2_players:  100, //SCORE TO REACH IF THERE ARE 2 PLAYERS
                                                score_to_reach_for_3_players:  150, //SCORE TO REACH IF THERE ARE 3 PLAYERS
                                                score_to_reach_for_4_players:  200, //SCORE TO REACH IF THERE ARE 4 PLAYERS
                                                
                                                score_ace: 1,            //SCORE ASSIGNED FOR ACE CARD WHEN ROUND IS OVER
                                                score_joker: 15,         //SCORE ASSIGNED FOR JOKER CARD WHEN ROUND IS OVER
                                                
                                                fullscreen:true     //SET THIS TO FALSE IF YOU DON'T WANT TO SHOW FULLSCREEN BUTTON
                                           });
				

---

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) Source Code - 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 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
   • CVector2: this class manages 2D Vectors.
   • CGame: this class manages the game logic
   • CInterface: this class controls game GUI that contains text and buttons
   • CAreYouSurePanel: this class show are you sure panel.
   • CAiController: this class manages the AI opponents.
   • CCard: this class manages the card sprite.
   • CCardHandDisplay: this class manages the cards of each player.
   • CHelpPanel: this class shows help panel.
   • CCreditsPanel: this class shows credits panel.
   • CChoosePanel: this class shows message box during gameplay
   • CComboOnTable: this class manages the combos placed on the table.
   • CCursorHandController: this class manages the help cursor while playing.
   • CDeckController: this class manages the card deck on the table.
   • CEasing: this class contains some easing functions for the tweening.
   • CGuiExpandible: this class manages setting button in game GUI.
   • CGameOverPanel: this class show a message box when round is over.
   • CHandEvaluatorController: this class manages the evaluation of the cards.
   • CNickLabel: this class shows the player nickname.
   • CRummyAnim: this class show the rummy animation.
   • CScoreBoard: this class shows player scores in round over panel.
   • CSelectNumPlayersPanel: this class shows the panel where user can choose the number of players.
   • CTableController: this class manages the table where the cards are placed.
   • CWinPanel: this class shows the game over panel.
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 the user click the Play button in main menu, the CSelectNumPlayersPanel.js class is called and the number of players is shown
5. After selection, the game starts.
6. If the user click on the exit button in the down-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)and the GUI.
• _initHandPlayers()
  This function initialize all the card hands of the players.
• dealCardToPlayer()
  This function deal a card to a player.
• dealCardInWastePile()
  This function place a card in the waste pile.
• _checkComboUnderConstruction()
  This function checks if a card can be placed on a combo.
• _changeTurn()
  This function changes player turn.
• _checkCollisionBetweenCardAndHand()
  This function checks collision between a card and the player hand.
• _checkCollisionBetweenCardAndWastePile()
  This function checks collision between a card and the waste pile.
• _checkCollisionBetweenCardAndAttachSprite()
  This function checks collision between a card and a combo.
• unload
  This function is called when user want to exit from the game.
• _calculateScore()
  This function calculates the final score when a round is over.
• update()
  This function manages 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) 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

---