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

---

“Pachinko Neko”

---

Table of Contents

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

---

A) Description - top

Pachinko Neko is a HTML5 Casino Game. Have a taste of Japanese culture with this funny and cute game! Launch your balls in the board and set their power turning the wheel at the bottom. Your aim is to throw as many balls as possible inside the lucky holes to enter the bonus game, where, if you get three identical symbols, you'll win a prize (Please note this game is meant to be used for fun, no real prizes will be provided)!

The ZIP package contains the game with 768x1280 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("save_score", function (evt, iMoney) {
  								//alert("iMoney: "+iMoney );
  							});
  						});
  					

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

                                    var TEXT_PRELOADER_CONTINUE = "START";
                                    var TEXT_CURRENCY = "$";
                                    var TEXT_ARE_SURE = "ARE YOU SURE?";
                                    var TEXT_PAUSE = "PAUSE";
                                    var TEXT_GAMEOVER = "YOU RUN OUT OF MONEY, WANT TO RECHARGE?";
                                    var TEXT_BALLS_TO_PLAY = "YOU STILL HAVE SOME BALLS TO PLAY";

                                    var TEXT_HELP1     = "LAUNCH A BALL IN ONE OF THE LUCKY HOLES TO GET THE CHANCE TO ENTER THE BONUS GAME";
                                    var TEXT_HELP2     = "IN THE BONUS GAME, MATCH 3 IDENTICAL SYMBOLS TO GET A PRIZE";
                                    var TEXT_PAYTABLE = "PAYTABLE";

                                    var TEXT_DEVELOPED = "DEVELOPED BY";


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

				

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

                                        var oMain = new CMain({
                                            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   
                                            audio_enable_on_startup:false,      //ENABLE/DISABLE AUDIO WHEN GAME STARTS 
                                            show_credits:true,                  //ENABLE/DISABLE CREDITS BUTTON IN THE MAIN SCREEN

                                            bank_cash : 100,                    //THIS IS THE STARTING BANK CASH AMOUNT. THE GAME CHECKS IF THERE IS AVAILABLE CASH FOR WINNINGS.
                                            start_credits:100,                  //PLAYER START MONEY
                                            balls_per_bet:100,                  //BALLS PURCHASED PER BET 
                                            bet:4,                              //COST FOR BALLS PURCHASE
                                            win_occurrence:30,                  //WIN PERCENTAGE.SET A VALUE FROM 0 TO 100.
                                            /***********PAYTABLE********************/
                                            //MATCH 3 IDENTICAL SYMBOLS TO GET A PRIZE
                                            paytable: [
                                                1,                              //PRIZE WIN FOR COMBO SYMBOL 0
                                                2,                              //PRIZE WIN FOR COMBO SYMBOL 1
                                                4                               //PRIZE WIN FOR COMBO SYMBOL 2
                                            ]
                                        });
				

---

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 4 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) Source Code - 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 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
   • CHelpPanel: the help panel that is shown before game starting
   • CAreYouSurePanel: this class ensure the confirm to exit from game
   • levelsettings: this class manages pinball table structure.
   • CCreditsPanel: this class shows the credits
   • CEndPanel: this class shows end panel when game is over
   • CLocalStorage: this class manages game savings
   • CGUIExpandible: this class manages expandible GUI
   • CMsgBox: this class shows a generic message panel
   • CPausePanel: this class manages pause in game
   • CLightIndicator: this class manages lights animation in game
   • CObjectBuilder: this class creates physics objects
   • CPhysicsController: this class manages physics world and collisions
   • CTable: this class manages pinball table creation
   • CArrowStart: this class manages animation of arrows ball starting point
   • CAnimText: this class manages text animation
   • CBallsPool: this class manages balls
   • CBonusPlatform: this class manages neko center platform bonus
   • CBottomBar: this class manages botto bar gui
   • CController: this class manages game controller
   • CManekinekoAnim: this class manages neko animation
   • CReelColumn: this class manages reels of the bonus
   • CSymbolSettings: this class manages settings of bonus
   • CVector2: this class manages vectors operation
   • CWheelEngine: this class manages all reels bonus
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. Box2D.js is a library that manages the physics
5. Howler.js is a suite that manages the sounds
6. Screenfull.js manages the fullscreen functionality

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 CGame.js class is called and game starts
5. 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)and the GUI.
• unload
  This function is called when user want to exit from the game.
• gameOver()
  This function is called when game is over.
• buyBalls()
  This function is called when click on buy balls button.
• 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) Hide Credits - top

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

show_credits:false

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;

K) 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

---