“Squicky” Documentation by “Code This Lab S.r.l.” v1.0
“Squicky”
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 Content
- Getting Started
- HTML Structure
- CSS Files and Structure
- Source Code
- Game functions
- Change Graphic
- Disable Sounds
- Wordpress Plugin
A) Description - top
Squicky is a HTML5 Platform Game. This cute mouse needs your help to rescue his friends! Find all the keys to go to the next level. Collect coins and defeat enemies to increase your score.
The ZIP package contains the game with 1920x1080 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 Content - top
- 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).
- game
This folder contains the full game source code ready to be edited.
- 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.
- documentation
This folder contains the package instructions.
- 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 .
- Localization: You can easily change game text for different languages, changing string in CLang.js
var TEXT_ARE_YOU_SURE = "ARE YOU SURE?";
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";
var TEXT_GAME_OVER_WIN = "CONGRATULATIONS!";
var TEXT_GAME_OVER_LOSE = "GAME OVER";
var TEXT_GAME_OVER_NO_TIME = "YOU RAN OUT OF TIME!";
var TEXT_SCORE = "SCORE: %s";
var TEXT_TOTAL_SCORE = "TOTAL SCORE: %s";
var TEXT_PAUSE = "PAUSE";
var TEXT_LEVEL = "LEVEL: %s";
var TEXT_NOT_ENOUGH_KEYS = "NOT ENOUGH KEYS";
var TEXT_HELP = new Array();
TEXT_HELP[0] = "CONTROLS";
TEXT_HELP[1] = "COLLECT ALL THE KEYS AND REACH THE END OF THE LEVEL";
TEXT_HELP[2] = "COLLECT COINS AND DEFEAT ENEMIES TO INCREASE YOUR SCORE";
TEXT_HELP[3] = "RIDE THE AIRPLANE TO FLY AROUND THE LEVEL";
TEXT_HELP[4] = "DRINK A POTION TO BECOME INVINCIBLE FOR A WHILE";
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 8 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({
player_speed: 8, //SPEED OF PLAYER (DEFAULT:8)
jump_power: 13, //JUMP POWER OF PLAYER (DEFAULT:13)
jetpack_power: 10, //JETPACK POWER OF PLAYER (DEFAULT:10)
jetpack_gravity_reduction: 7, //GRAVITY REDUCTION OF PLAYER WHEN HE HAS COLLECTED THE JETPACK POWER UP (DEFAULT: 7)
climbing_speed: 5, //SPEED OF PLAYER WHEN HE IS CLIMBING STAIRS (DEFAULT: 5)
time_per_point:5000, //TIME IN MILLISECONDS PER 1 POINT (DEFAULT: 5000)
coin_score: 1, //SCORE YOU GAIN WHEN YOU COLLECT A COIN (DEFAULT: 1)
entity_0_score: 2, //SCORE YOU GAIN WHEN YOU DEFEAT AN ENTITY_0(GREY CAT) (DEFAULT: 2)
entity_1_score: 4, //SCORE YOU GAIN WHEN YOU DEFEAT A ENTITY_1(ORANGE CAT) (DEFAULT: 4)
entity_2_score: 8, //SCORE YOU GAIN WHEN YOU DEFEAT A ENTITY_2(WHITE CAT) (DEFAULT: 8)
fullscreen:true, //SET THIS TO FALSE IF YOU DON'T WANT TO SHOW FULLSCREEN BUTTON
check_orientation: false, //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
});
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 Sound library
- jQuery is a Javascript library that greatly reduces the amount of code that you must write.
- The game have the following js files:
- CCTLText: this class creates a text that autofit in an area.
- CLang: global string variables for language localization.
- CLocalSavings: this file contains the functions for local savings.
- 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
- levels: this file contains all levels' infos.
- settings: general game settings.
- CButLang: this class creates a button that manages the game language.
- CCreditsPanel: this class shows the Credits Panel.
- CMenu: simple menu with the play button.
- CMenuScene: this class manages the menu scene.
- CMsgBox: this class shows an alert when local storage is not available.
- CLevelButton: this class creates a button used in level panel.
- CLevelMenu: this class manages the level menu.
- CLevelPanel: this class creates a level panel.
- CLevelPanelController: this class manages two level panels.
- CAlert: this class shows a panel with a message.
- CAreYouSurePanel: this class manages a panel with two choices.
- CCell: this class creates a cell.
- CEndPanel: this class manages the panel that is shown when the game is over.
- CGame: this class manages the game logic.
- CGUIExpandible: this class manages the setting button in the game GUI.
- CHelpPanel: this class manages the help panel.
- CHitAreaButton: this class create a button with an hit area.
- CInterface: this class controls game GUI that contains text and buttons.
- CJoypad: this class creates a joypad used for mobile devices.
- CLevelController: this class manages a level.
- CLock: this class creates a lock.
- CMobileController: this class manages mobile devices' commands.
- CMovingContainer: this class manages a moving container.
- CMovingPlatform: this class creates a moving platform.
- CPhysicsController: this class manages box2d objects.
- CPlayer: this class manages the player.
- CPuff: this class manages a puff.
- CTimePanel: this class manages the time panel.
- CBullet_0: this class manages a piercing bullet with infinite range (NOT IMPLEMENTED).
- CBullet_1: this class manages a bullet with infinite range (NOT IMPLEMENTED).
- CBulletBase: base class for bullets.
- CCoin: this class creates a coin.
- CInvulnerabilityCollectible: this class creates a power-up that makes player invincible.
- CJetpack: this class creates a power-up that lets player fly.
- CKey: this class creates a key.
- CCollectibleBase: base class for collectibles.
- CEntity_0: this class creates an enemy that walks from a cell to another one.
- CEntity_1: this class creates an enemy that walks and change direction when it encounters an obstacle.
- CEntity_2: this class creates a flying enemy that follows a given path.
- CSpike: this class creates a spike.
- CEntityBase: base class for entities.
- CCage: this class creates a cage.
- CDoor: this class creates a door.
- CHole: this class creates a hole that can teleport the player to a cell of any level stage.
- CLadder: this class creates a ladder.
- CSpecialBase: base class for special objects.
- CGfxButton: this class create a standard button.
- CPreloader: simple text preloader to show resources loading progress.
- ctl_utils: this file manages the canvas resize and its centering.
- CToggle: this class create a standard toggle button.
- CTweenController: this class contains some easing functions.
- sprite_lib: this class loads all images declared in the main class.
- 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 javascript Audio library.
- Box2D is a 2D physics engine for games.
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 main class shows the level menu
- When the user select a level, the game starts
- 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.
- restart()
This function reset all game variables.
- unload
This function is called when user want to exit from the game.
- _gameOver()
This function is called when game is over.
- onKeyDown()
this function is called when a key is pressed.
- onKeyUp()
this function is called when a key is released.
- onPlayerDead()
this function is called when the player dies.
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