“Ultimate Boxing” Documentation by “Code This Lab S.r.l.” v1.0
“Ultimate Boxing”
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
- JavaScript
- Game functions
- Change Graphic
- Disable Sounds
- Wordpress Plugin
A) Description - top
Ultimate Boxing is a HTML5 Sport Game. Face your opponent in the ring in this exciting 3D game.
The ZIP package contains the game with 690x960 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
- 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.
- readme
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. WARNING: The game won't run locally with some browser like Chrome due to some security restrictions.
- 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_BOXERW = "IRONFIST";
TEXT_BOXERB = "DYNAMITE";
TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";
Game option: You can easily customize game setting when creating a new instance of the game in index.html file
var oMain = new CMain({
enemy_attack_occurr:70, //The enemy percentage of attack values(0-100)
enemy_min_action_time:200, //The minimum time after wich the enemy will act
enemy_max_action_time:900, //The maximum time after wich the enemy will act
enemy_min_guard_time:500, //The minimum enemy guard time
enemy_max_guard_time:1000, //The maximum enemy guard time
enemy_hp:100, //The enemy health points
player_hp:100, //The player health points
player_stamina:100, //The player stamina
stamina_punch_limit:10, //The player's minimum stamina to attack
player_stamina_regen_speed:1.5, //Regeneration speed of the player stamina
jab_damage: 3, //The damage inflicted to hp by jab
hook_left_damage:6, //The damage inflicted to hp by left hook
hook_right_damage:6, //The damage inflicted to hp by right hook
uppercut_damage:9, //The damage inflicted to hp by uppercut
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
});
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 6 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) JavaScript - top
This game contains:
- jQuery
- Our custom scripts
- CreateJs plugin
- hammer.js
- 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:
- 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
- CSelectCharacter: this class manages the panel where the user chooses the boxer
- CBitmapFont: this class manages the font spritesheet
- CPiece: this class manages the sliding tile
- CEnemy: this class controls the enemy boxer
- CPlayer: this class controls the player boxer
- CHelpPanel: this class shows the tutorial panel before game starting
- CSelectButton: this class creates a player selection button to be used into Select Character Panel
- CVersusPanel: this class shows the versus panel before game starting
- CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
- hammer.js is a third-party library that manages swipe gestures and touch event in general.
- Howler is a javascript Audio library.
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 CSelectCharacter.js file is loaded and the user can choose a boxer
- After selecting a boxer, the CGame.js class is called
- 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), GUI, the player and enemy boxers.
- _initHammer()
This function initialize hammer library for the gestures.
- hitEnemy()
This function is called when player punch the enemy.
- hitPlayer()
This function is called when enemy punch the player.
- regenStamina
This function increase the player stamina after a time interval.
- playerKo()
This function is called when player is going KO.
- enemyKo()
This function is called when enemy is going KO.
- update()
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) 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