“Cyclops Ruins” Documentation by “Code This Lab S.r.l.” v1.0

“Cyclops Ruins”

Created: 22/03/2017
By: Code This Lab S.r.l.
Email: info@codethislab.com

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!

Description
Folder Contents
Getting Started
HTML Structure
CSS Files and Structure
Source Code
Game functions
Change Graphic
Disable Sounds
Wordpress Plugin

A) Description - top

Cyclops Ruins is a HTML5 Skill Game.
Help this mighty hero in his journey to beat the furious cyclops.
Move around to get bonus, coins and power ups. Avoid the falling debris, or you’ll lose energy!

The ZIP package contains the game with 768x1400 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_DESKTOP = "USE LEFT AND RIGHT ARROWS TO CONTROL THE HERO. THE LONGER A KEY IS PRESSED, THE FASTER THE HERO WILL MOVE";
                                    TEXT_MOBILE = "SWIPE LEFT OR RIGHT TO CONTROL THE HERO. THE FURTHER YOUR FINGER WILL BE FROM THE CENTER OF THE SCREEN, THE FASTER THE HERO WILL MOVE";
                                    TEXT_ORIENTATION = "TURN YOUR PHONE LEFT OR RIGHT TO CONTROL THE HERO. THE MORE YOU'LL ROTATE THE PHONE, THE FASTER THE HERO WILL MOVE";
                                    TEXT_GAMEOVER = "GAME OVER!";
                                    TEXT_ARE_SURE = "ARE YOU SURE?";
                                    TEXT_CREDITS_DEVELOPED = "DEVELOPED BY";

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({
                                        player_spd_max: 15, //maximum speed that the player can reach
                                        player_spd_min: 0.2, //minimum speed that the player can reach
                                        player_acceleration_no_giroscope: 1.2, //the accelleration to moltiply to the velocity to the player when there is no giroscope on device
                                        player_acceleration_giroscope: 1.4, //the accelleration to moltiply to the velocity to the player when there is the giroscope on device
                                        player_deceleration: 0.9, //deceleration to add to the player in way to reache the player_spd_min
                                        gamma_range_accepted: 2, //maxinum gamma read from the game, the more it is, the more the game is difficult (if there is a giroscope)
                                        canvas_half_width_range_accepted: 215, //cursor range accepted (calculated by the half measure of the canvas width +- this value), if there is no giroscope
                                        stones_creation_interval: 3000, //how many milliseconds to wait between each stone to be created
                                        shield_creation_interval: 20000, //how many milliseconds to wait between each shield to be created
                                        health_creation_interval: 30000, //how many milliseconds to wait between each health potion to be created
                                        coin_disappearing_interval: 3000, //how many milliseconds to wait before a coin disappears
                                        coin_points: 1, //how many points a taken coin is valued
                                        health_points: 50, //how many health points a taken bonus will give back
                                        shield_duration: 10000, //how many milliseconds will the shield bonus be valid
                                        player_life: 100, //the player's health points
                                        damage: 10, //how many health points a stone will give to the player
                                   });

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

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
- CButtonPlay: this class create the "play" button animation
- 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
- CAreYouSurePanel: this class manages the exit confirmation panel
- CCreditsPanel: this class manages the credits panel
- CEndPanel: this class manages the gameover panel
- CHelpPanel: this class manages the help panel
- CMsgBox: this class manages the message box
- CWinPanel: this class manages the winning panel
- CCoin: this class manages the coins' creation and collisions check
- CCyclops: this class manages the cyclops' animation and behaviours
- CDebris: this class manages the debris' animation and creation
- CPlayer: this class manages the player's animation and behaviours
- CPowerUp: this class manages the bonuses' (health / shield) creation and collisions check
- CShake: this class manages the camera shake effect
- CStone: this class manages the stone's creation and collisions check
- CTweenController: this class manages the tweens
CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.

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 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.
_initCyclops
This function creates the background cyclops.
_initPlayer
This function creates the player.
_onExit
This function is triggered when exit button is clicked.

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