“Rugby Kicks” Documentation by “Code This Lab S.r.l.” v1.0

“Rugby Kicks”

Created: 22/03/2019
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. Folder Contents
  3. Getting Started
  4. HTML Structure
  5. CSS Files and Structure
  6. Source Code
  7. Game functions
  8. Change Graphic
  9. Disable Sounds
  10. Wordpress Plugin

A) Description - top

Rugby Kicks is a HTML5 Sport Game. The crowd is screaming... All eyes are on you... How many points will you score?

The ZIP package contains the game with 640x1024 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:

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. To let it work correctly you have to upload it online.

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 7 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
  <script>
   $(document).ready(function(){
            $(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 THE EXIT BUTTON IS CLICKED.
            });
             
            $(oMain).on("start_level", function(evt,iLevel) {
                    //THIS EVENT IS TRIGGERED WHEN A NEW KICK POSITION IS SHOWN
            });
             
            $(oMain).on("end_level", function(evt,iLevel) {
                    //THIS EVENT IS TRIGGERED WHEN USER COMPLETES ALL THE KICKS IN THE CURRENT KICK POSITION.
             });
              
            $(oMain).on("save_score", function(evt,iScore, szMode) {
                    //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 GAME OVER IS SHOWN.
             });
           });
         
  </script>
   
<canvas id="canvas" class="ani_hack" width="640" height="1024"> </canvas>
  • Game option: You can easily customize game setting when creating a new instance of the game in index.html file
    • ?
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    var oMain = new CMain({
                            shot_indicator_spd: 2200,           //STARTING TIME IT TAKES THE TOKEN TO GO FROM SIDE TO SIDE OF THE KICKING BAR. 
                                                                //IT IS EXPRESSED IN MILLISECONDS
                                                                //INCREASE THIS VALUE IF YOU WANT TO SLOW DOWN THE TOKEN
                            decrease_shot_indicator_spd: 200,    //EVERY NEW LEVEL, THE GAME WILL DECREASE THIS AMOUNT FROM THE STARTING TIME ABOVE
                                                                //DECREAE THIS VALUE TO MAKE THE GAME EASIER
                             
                            shots_per_stage: 5,                 //NUMBER OF SHOTS PER STAGE
                             
                            red_area_points: 100,               //POINTS GAINED TO GET THE BALL IN RED AREA
                            yellow_area_points: 200,            //POINTS GAINED TO GET THE BALL IN YELLOW AREA
                            green_area_points: 500,              //POINTS GAINED TO GET THE BALL IN GREEN AREA
                            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:

    1. jQuery
    2. Our custom scripts
    3. CreateJs plugin
    4. Howler Sound library
    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 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
      • CVector2: this class manages 2D Vectors.
      • CGame: this class manages the game logic
      • CInterface: this class controls game GUI that contains text and buttons
      • CAreYouSurePanel: this class show are you sure panel.
      • CBall: this class manages the ball.
      • CPlayer: this class manages the player animation.
      • CEndPanel: this class shows end panel.
      • CHelpPanel: this class shows help panel.
      • CCreditsPanel: this class shows credits panel.
      • CGoalArea: this class manages the goal area.
      • CRollingTextController: this class manages the score animation rolling.
      • CTweenController: this class manages ease interpolation.
      • CScoreText: this class manages goal score animation.
      • CShotIndicatorController: this class manages shot control bar.
      • CButFlag: this class manages the button in Team Choosing Panel.
      • CChooseMenu: this class show the Panel for the team selection.
      • CLoaderResourcesPanel: this class manages the team sprites loading.
    3. CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
    4. Howler is a javascript Audio library.

    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" and "/sounds" folder are loaded, the main class removes the preloader and calls the CMenu.js file that shows the main menu
    4. If the user click the Play button in main menu, the CChooseMenu.js class is called and the team selection panel is shown
    5. After team selection, the game loads all team sprites. Once loading is over, the game starts.
    6. 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.

    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:

    ?
    1
    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.

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