“Snakes And Ladders” Documentation by “Code This Lab S.r.l.” v1.0
“Snakes And Ladders”
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
Snakes And Ladders is a HTML5 Board Game.
100 squares full of traps and tricks...Roll the dice and try your luck!
Ladders will take you up but Snakes will take you down!
Are you afraid of serpents? No problem!
There is the version with chutes and cute babies ready for you!
Two games in one...what else?
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
TEXT_HELP1 = "REACH THE END OF THE BOARD LAUNCHING THE DICE. ROLLING A 6 WILL GIVE THE PLAYER AN EXTRA DICE.";
TEXT_HELP2_PT1 = "LADDER: YOU GO UP! ";
TEXT_HELP2_PT2 = ": YOU GO DOWN!";
TEXT_MODE0 = "SNAKE";
TEXT_MODE1 = "CHUTE";
TEXT_EXTRA_DICE = "EXTRA DICE!";
TEXT_SELECT_MODE = "SELECT GAME MODE";
TEXT_SELECT_PLAYERS = "SELECT PLAYERS";
TEXT_SELECT_COLOUR = "SELECT YOUR COLOUR";
TEXT_GAMES_PLAYED = "GAMES PLAYED";
TEXT_GAMES_WON = "GAMES WON";
TEXT_WIN = "YOU WON";
TEXT_LOSE = "YOU LOSE";
TEXT_PAUSE = "PAUSE";
TEXT_ARE_SURE = "ARE YOU SURE?";
TEXT_MOTIVATIONAL0 = "GREAT!";
TEXT_MOTIVATIONAL1 = "COOL!";
TEXT_MOTIVATIONAL2 = "NICE!";
TEXT_MOTIVATIONAL3 = "SUPER!";
TEXT_MOTIVATIONAL4 = "GOOD!";
TEXT_DEMOTIVATIONAL0 = "BAD ROLL!";
TEXT_DEMOTIVATIONAL1 = "NOOOO!";
TEXT_DEMOTIVATIONAL2 = "SORRY...";
TEXT_DEMOTIVATIONAL3 = "UNLUCKY!";
TEXT_DEMOTIVATIONAL4 = "BAD RESULT!";
TEXT_CREDITS_DEVELOPED = "Developed by";
TEXT_LINK = "www.codethislab.com";
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({
perfect_score:true, // IF THE PLAYER HAS TO MAKE A PERFECT SCORE OR NOT, TO REACH THE END
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
- 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
- CMenu: simple menu with the play button
- CModeChoose: a menu to select the type of game (snakes or chutes)
- CColourChoose: a menu to select the colour of the player
- CDice: this class manage the dice launch and random generator
- CGfxButton: this class create a standard button
- CSpritesheetButton: this class create a button with a spritesheet
- 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
- CPlayers: this class manages the players
- CPauseButton: this class manages the pause functions
- CPlayersInterface: this class controls the GUI of the players playing
- CSquares: this class controls the game board and special squares
- CPlayersChoose: this class manage the selection menu for how many players will be in the game
- CErrorMsgBox: this class manages the message box for some errors
- 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.
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 CTeamChoose.js class is called and a players number selection screen starts
- If the user selects how many players he wants, the CColourChoose.js class is called and a players colour selection screen starts
- If the user selects his colour, 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.
- checkForSpecialSquares()
This function check the square the player is in, to find special features.
- changeTurn()
This function will change the turn and pass to the next player.
- playerAdvance()
This function controls the forward movement of the player.
- playerBack()
This function controls the backward movement of the player.
- onWin()< br>
This function controls when a player reaches the final square, to see if the player wins or loses.
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