“Slot Machine - Lucky Christmas” Documentation by “Code This Lab S.r.l.” v1.0

“Slot Machine - Lucky Christmas”

Created: 06/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 symbols
  9. Bonus Panel
  10. Hide Credits
  11. Disable Sounds
  12. Wordpress Plugin

A) Description - top

Slot Machine - Lucky Christmas is a HTML5 Casino game. Enjoy this seasonal slot machine with bonus game and hold reel feature!

The ZIP package contains the game with 1500x640 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-known 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:
  2. 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).
  3. game
  4. This folder contains the full game source code ready to be edited.
  5. live_demo
  6. This folder contains the obfuscated code. You should upload this folder on your server if you don't need to make any changes.
  7. readme
  8. This folder contains the package instructions.
  9. thumbs
  10. This folder contains all game icons.

C) Getting Started - top

To install the game just upload on your server the game folder live_demo.

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 5 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 styles 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
  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 play button
    • CGfxButton: this class create a standard button
    • CTextButton: this class create a standard text button
    • CHelp: this class manages the help panel that appears when game starts
    • CGame: this class manages the game logic
    • CPayTablePanel: this class manages the paytable panel that is shown clicking the info button
    • CInterface: this class controls game GUI that contains text and buttons
    • CEndPanel: this class controls the game over panel that appears when player lose all the lives
    • CSlotSettings: this class contains all infos relative to symbols, combos and their animations
    • CBonusPanel: this class manages the bonus 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.

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" 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. The User can start slot spinning, clicking the spin button on the right
  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.

H) Change symbols - top

The game contains the symbol spritesheets that you must edit if you want to change symbol images.
You have to edit two png to change any particular symbol in game: symbol_[index].png and symbol_[index]_anim.png.

I)Bonus Panel - top

The bonus is actived if, after reel spinning, 3 (occurrence value) or more symbol 9 (the ribbon bow) are displayed. You can change the occurrence value in index.html file.
The number of ribbon bows to show on the fence is equal to the number of symbols shown after the spin (if more than 5, we have 5 ribbon bows).
The goal of the bonus is to get the best prizes clicking on a random ribbon bow. The win percentage can be set in index.html file:

		perc_win_bonus_prize_1: 50,       //OCCURENCE PERCENTAGE FOR BONUS PRIZE 1 IN BONUS
        perc_win_bonus_prize_2: 35,       //OCCURENCE PERCENTAGE FOR BONUS PRIZE 2 IN BONUS
        perc_win_bonus_prize_3: 15,       //OCCURENCE PERCENTAGE FOR BONUS PRIZE 3 IN BONUS

bonus game

J) Hide Credits - top

If you want to hide credits in main menu, change to false the following value in index.html file:


K) Disable Sounds - top

The game avoid sound playing if loaded on any mobile device. If you want to enable sounds also on mobiles, you have to change the following value in settings.js file:


L) 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.

Minimum Requirements:

This plugin is designed to work only with games built by Code This Lab.

You can find it here!

ctl arcade

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.


Go To Table of Contents