“Flappy Ball” Documentation by “Code This Lab S.r.l.” v1.0

“Flappy Ball”

Created: 13/02/2014
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!

Table of Contents

  1. Description
  2. Getting Started
  3. HTML Structure
  4. CSS Files and Structure
  5. JavaScript
  6. Game functions
  7. Change Graphic
  8. Disable Sounds
  9. Wordpress Plugin

A) Description - top

Flappy Ball is a HTML5 action game. The game is freely inspired to the popular game "Flappy Bird". The goal of the player is to tap the screen to let the ball survive as long as possible avoiding the poles.
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) Getting Started - top

To install the game just upload on your server the game resolution you need. You can choose among 320x480,320x568 or 768x1024. WARNING: The game won't run locally with some browser like Chrome due to some security restrictions.

C) 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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
  <script>
    $(document).ready(function(){
             var oMain = new CMain();
 
             $(oMain).on("start_session", function(evt) {
                    //THIS EVENT IS TRIGGERED WHEN PLAY BUTTON IN MENU SCREEN IS CLICKED
             });
              
            $(oMain).on("end_session", function(evt) {
                    //THIS EVENT IS TRIGGERED WHEN GAME IS OVER OR THE EXIT BUTTON IS CLICKED.
            });
             
            $(oMain).on("start_level", function(evt,iLevel) {
                    //THIS EVENT IS TRIGGERED WHEN A NEW LEVEL STARTS
             });
              
            $(oMain).on("end_level", function(evt,iLevel) {
                    //THIS EVENT IS TRIGGERED WHEN CURRENT LEVEL IS OVER.
            });
             
            $(oMain).on("restart_level", function(evt,iLevel) {
                    //THIS EVENT IS TRIGGERED WHEN CURRENT LEVEL IS RESTARTED.
            });
             
            $(oMain).on("save_score", function(evt,iScore) {
                    //THIS EVENT IS TRIGGERED WHEN GAME IS OVER. IT CAN BE USEFUL TO CALL PHP SCRIPTS (NOT PROVIDED IN THE PACKAGE) THAT SAVE THE SCORE.
             });
              
             $(oMain).on("show_interlevel_ad", function(evt) {
                    //THIS EVENT IS TRIGGERED WHEN GAME IS OVER. MAY BE USEFUL TO CALL ADS SCRIPT.
             });
              
             $(oMain).on("share_event", function(evt,iScore) {
                    //THIS EVENT IS TRIGGERED WHEN USER CLICK EXIT BUTTON. CAN BE USEFUL TO CALL SHARING FEATURE SCRIPTS.
             });
   });
 
</script>
<canvas id="canvas" class="ani_hack" width="768" height="1400"> </canvas>

D) 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

E) JavaScript - top

This game contains:

  1. jQuery
  2. Our custom scripts
  3. CreateJs plugin
  1. jQuery is a Javascript library that greatly reduces the amount of code that you must write.
  2. 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 game sounds, 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 play button
    • CGfxButton: this class create a standard button
    • CTextButton: this class create a standard text button
    • CToggle: this class create a standard toggle button
    • CHelpPanel: this class manages the help panel that appears when game starts
    • CGame: this class manages the game logic
    • CHero: the ball controlled by the player
    • CObstacle: this class controls the poles
    • CScrollingBg: the scrolling background
    • CInterface: this class controls game GUI that contains text and buttons
    • CEndPanel: this class controls the game over panel that appears when player lose all the lives
  3. 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:

  1. The index.html file calls the CMain.js file after ready event is called
  2. The main class calls CPreloader.js to init preloader text and start sprite loading
  3. When all sprites contained in "/sprites" folder and sounds (if not mobile) are loaded, the main class removes the preloader and calls the CMenu.js file that shows the main menu
  4. If user click on the play button in main menu, the CGame.js class is called and the game starts
  5. The game class shows immediately a help screen that explain briefly the game instructions. When the player tap the first time, the game starts
  6. If the ball hit a pole or falls to the ground, the game is over
  7. If the user click on game over panel, the game restart

F) Game functions - top

In this section will be explained all the most important functions used in CGame.js file.

G) 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.

H) 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:

?
1
var DISABLE_SOUND_MOBILE = true;


I) 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.

Minimum Requirements:

This plugin is designed to work only with games built by Code This Lab.

You can find it here!

ctl arcade

Once again, thank you so much for purchasing this game. Fell 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