“Plumber Soda” Documentation by “Code This Lab S.r.l.” v1.0
“Plumber Soda”
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
- Description
- Folder Contents
- Getting Started
- HTML Structure
- CSS Files and Structure
- Source Code
- Game functions
- Change Graphic
- Disable Sounds
- Wordpress Plugin
A) Description - top
Plumber Soda is a HTML5 Puzzle Game.
Fill your bottle with an iced soda!
Click on the straw pieces to rotate them and connect the soda keg to the bottle.
You have a limited number of moves, do not waste them! And be careful to the unuseful pieces that may trick you!
The ZIP package contains the game with 1360x640 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 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_HELP1 = "ROTATE THE PIPES BY CLICKING ON THEM TO CONNECT THE START PIPE WITH THE END";
var TEXT_HELP2 = "TRY TO COMPLETE THE PIPE LINE WITHOUT RUNNING OUT OF POSSIBLE MOVES";
var TEXT_HELP3 = "BEWARE! SOME PIPES MAY NOT BE USEFUL FOR YOU, DON'T LET THEM TRICK YOU!";
var TEXT_SELECT_LEVEL = "SELECT LEVEL";
var TEXT_SELECT_MASCOTTE = "SELECT PLAYER";
var TEXT_WIN = "YOU WON!";
var TEXT_LOSE = "YOU LOSE!\nTRY AGAIN?";
var TEXT_PAUSE = "PAUSE";
var TEXT_ARE_SURE = "ARE YOU SURE YOU WANT TO EXIT?\nALL UNSAVED PROGRESS WILL BE LOST";
var TEXT_SCORE = "SCORE";
var TEXT_LEVEL_SCORE = "LEVEL SCORE: ";
var TEXT_TOTAL_SCORE = "TOTAL SCORE: ";
var TEXT_LEVEL = "LEVEL";
var TEXT_DELETE_SAVE = "ALL YOUR PROGRESSES WILL BE DELETED\n\nARE YOU SURE?";
var TEXT_PRELOADER_CONTINUE = "START";
var TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";
var TEXT_LINK = "www.codethislab.com";
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 4 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({
star_score: 100, // HOW MANY POINTS A COLLECTED STAR IS VALUED
all_levels_unlocked: false, // SET THIS TO TRUE IF YOU WANT TO UNLOCK THE FULL GAME
audio_enable_on_startup:false, //ENABLE/DISABLE AUDIO WHEN GAME STARTS
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
});
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:
- jQuery
- Our custom scripts
- CreateJs plugin
- Howler plugin
- Screenfull plugin
- jQuery is a Javascript library that greatly reduces the amount of code that you must write.
- 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
- game_settings: internal game settings
- CLang: global string variables for language localization
- CPreloader: simple text preloader to show resources loading progress
- CTweenController: this class manages the tween movements
- CMenu: simple menu with the play button
- CGfxButton: this class create a standard button
- CToggle: this class create a standard toggle button
- CGame: this class manages the game logic
- CInterface: this class controls game GUI that contains text and buttons
- CAreYouSurePanel: this class manages the exit confirmation panel
- CCreditsPanel: this class manages the credits panel
- CLosePanel: this class manages the gameover panel when the player loses
- CWinPanel: this class manages the gameover panel when the player wins
- CHelpPanel: this class manages the help panel
- CMsgBox: this class manages the message box
- CPause: this class manages the pause functions
- CPipe: this class controls the pipes and squares
- CBoard: this class set the board game and everything related
- CLevelMenu: a menu to select the level to play
- CLevelSettings: a class settings each level
- CLevelBut: this class create a level selection button
- CMascotte: this class create the mascotte/player of the game
- CMascotteSelection: this class select the mascotte/player of the game
- CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
- Howler is a library that manages audio.
- Screenfull.js manages the fullscreen functionality
Resuming, the complete game flow is the following:
- The index.html file calls the CMain.js file after ready event is called
- The main class calls CPreloader.js to init preloader text and start sprite loading
- 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
- If the user click the Play button in main menu, the CMascotteSelection.js class is called and mascotte/player selection screen starts
- If the user select the mascotte/player in the selection menu, the CLevelChoose.js class is called and level selection screen starts
- If the user selects the level he wants to play, the CGame.js class is called and the game starts
- 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.
- restart()
This function is called when user want to restart the game.
- unload()
This function is called when user want to come back to the menu screen.
- initStartPipe()
This function set the starting pipe, where the soda will start to flow from.
- startWater()
This function will make the soda start to flow.
- checkLevel()
This function check if the level is passed or not.
- gameOver()
This function will be called when the player loses the level.
- gameWin()< br>
This function will be called when the player wins the level.
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