Roulette 3D

### “Roulette 3D” Documentation by “Code This Lab S.r.l.” v1.0

# “Roulette 3D”

Created: 17/07/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. Set Win Occurrence
5. HTML Structure
6. CSS Files and Structure
7. JavaScript
8. Game functions
9. Disable Sounds
10. Wordpress Plugin

### A) Description - top

Roulette 3D is a HTML5 casino game. Enjoy this roulette game with high quality 3D graphic!
The game contains all the main roulette game features like Voisins zero, tier, orphelins, neighbor,final bets. The ZIP package contains the game with 750x600 resolution that automatically scales PROPORTIONALLY to fit current screen device and all the assets to grant complete game customization.
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 each time roulette is spinned, you can add it in the index.html file:

      						$(document).ready(function(){
      							var oMain = new CMain();

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

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

    					TEXT_GAMEOVER  = "GAME OVER";
    					TEXT_CONGRATS  = "CONGRATULATIONS";
    					TEXT_MONEY     = "MONEY";
    					TEXT_PLAY      = "PLAY";
    					TEXT_BET       = "BET";
    					TEXT_COIN      = "COIN";
    					TEXT_MAX_BET   = "MAX BET";
    					TEXT_INFO      = "INFO";
    					TEXT_LINES     = "LINES";
    					TEXT_SPIN      = "SPIN";
    					TEXT_EXIT      = "EXIT";
    					TEXT_RECHARGE  = "RECHARGE";
    					TEXT_CLEAR_LAST_BET = "CLEAR LAST BET";
    					TEXT_CLEAR_ALL_BET = "CLEAR ALL BETS";
    					TEXT_VOISINS_ZERO = "VOISINS DU ZERO";
    					TEXT_TIER = "TIER";
    					TEXT_ORPHELINS = "ORPHELINS";
    					TEXT_NEIGHBORS = "NEIGHBORS";
    					TEXT_FINALSBET = "FINALS BET";
    					TEXT_WIN       = "WIN";
    					TEXT_HELP_WILD = "THIS SIMBOL IS A JOLLY WHICH \nCAN REPLACE ANY OTHER \nSYMBOL TO MAKE UP A COMBO";
    					TEXT_ERROR_NO_MONEY_MSG="NOT ENOUGH MONEY\n FOR THIS BET!!";
    					TEXT_ERROR_MAX_BET_REACHED="MAX BET REACHED!!";
    					TEXT_MIN_BET = "MIN BET";
    					TEXT_MAX_BET = "MAX BET";
    					TEXT_DISPLAY_MSG_WAITING_BET = "WAITING FOR\n YOUR BET";
    					TEXT_SPINNING = "SPINNING...";
    					TEXT_DISPLAY_MSG_PLAYER_WIN="PLAYER WON ";
    					TEXT_IMAGE_FAIL = "CAN'T FIND FILE:";
    					TEXT_NO_MONEY = "YOU DON'T HAVE ENOUGH MONEY!!!";
    					TEXT_RECHARGE_MSG = "PLEASE CLICK RECHARGE BUTTON TO PLAY AGAIN";

    					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({
                                        money: 1000,      //STARING CREDIT FOR THE USER
    									min_bet: 0.1,     //MINIMUM BET
    									max_bet: 100,     //MAXIMUM BET
    									time_bet: 10000,  //TIME TO WAIT FOR A BET IN MILLISECONDS. SET 0 IF YOU DON'T WANT BET LIMIT
    									time_winner: 3000, //TIME FOR WINNER SHOWING IN MILLISECONDS
    									win_occurrence: 25, //Win occurrence percentage (100 = always win).
    														//SET THIS VALUE TO -1 IF YOU WANT WIN OCCURRENCE STRICTLY RELATED TO PLAYER BET ( SEE DOCUMENTATION)
    									casino_cash:4000,    //The starting casino cash that is recharged by the money lost by the user
    									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
    									num_hand_before_ads:2    //NUMBER OF HANDS TO COMPLETE, BEFORE TRIGGERING SAVE_SCORE EVENT. USEFUL FOR INTER-LEVEL AD EVENTUALLY.
                                    });

### D) Set Win Occurrence - top

You can set the win occurrence percentage, editing the parameter 'win_occurrence' in index.html. Set a value between 0 and 100.
If you want to keep win occurrence completely random, set this value to -1. In this case the win occurence is related to the player bet ( e.g.: red/black bet have 50% win occurrence; betting on a single number has around 2.5% win occurrence and so on...)
The win occurrence is strictly related to the 'casino_cash' parameter, that is the amount of money that the casino table currently have. So if the casino money are less than the current player bet, the player can't win.

### E) 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

### F) 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

### G) 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
   - CGame: this class manages the game logic
   - CBetTableButton:
   - CInterface: this class controls game GUI that contains text and buttons
   - CGameOver: this class controls the game over panel that appears when player lose all the lives
   - CBetTextButton: this class contains all infos relative to symbols, combos and their animations
   - CEnlight: this class manages the sprites that enlight bets on table
   - CFiche: this class manages the fiche sprite
   - CFicheBut: the buttons on table to select the fiche
   - CFichesController: this class manages the fiches on table
   - CFinalBetPanel: this class manages the Final Bet Panel
   - CHistoryRow: this class store all the number extracted
   - CMsgBox: this class manages the message box that appear for warning
   - CNeighborsPanel: this class manages the Neighbor panel
   - CRouletteSettings: this class contains all the info about roulette spinning fames, fiche values, etc..
   - CSeat: this class manages some user info like money, current bet, etc...
   - CTableController: this class manages all table bet button
   - CTweenController: this class manages the fiches tweening
   - CWheelAnim: this class manages the roulette wheel animation on the left
   - CWheelTopAnim: this class manages the roulette wheel top-view animation
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 roulette spinning, clicking one of the chips on table
6. If user click on the exit button in the up-left corner, the game returns to the menu screen

### H) 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 Table Controller, Fiche Controller and other panels.
- unload()
  This function removes all images from canvas and event listeners on buttons. It's called when user decide to exit from the game.
- _generateWinLoss()
  This function choose randomically if the user should win or lose after wheel spinning.
- _rouletteAnimEnded()
  This function is called when wheel spinning is finished.
- onSpin()
  This function is called when user click spin button.
- _onShowBetOnTable()
  This function shows the chips on the table.
- update()
  This function manages the game loop.

### J) 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