“Swimming Pro” Documentation by “Code This Lab S.r.l.” v1.0

“Swimming Pro”

Created: 24/03/2016
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 Content
  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

Challenge the best swimmers in the world and beat their time! Collect medals to increase your energy and step to the podium of champions!

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

  1. ctl_arcade_wp_plugin:
    2. 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).
  2. game
    3. This folder contains the full game source code ready to be edited.
  3. live_demo
    4. This folder contains the obfuscated code. You should upload this folder on your server if you don't need to make any changes.
  4. readme
    5. This folder contains the package instructions.
  5. thumbs
    6. This folder contains all game icons.

C)Getting Started - top

To install the game just upload on your server the game folder live_demo.

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 8 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({
                                            shot_indicator_spd: 1000,           //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
                                            num_rounds: 1,
                                            player_max_speed: 6,
                                            player_min_speed: 2,
                                            player_energy: 100,
                                            player_resistence_step: 2,
                                            player_max_speed_adder: 0.3,
                                            player_energy_adder: 5,
                                            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's loading, the loop game and initializes 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 creates a standard button
      • CToggle: this class creates a standard toggle button
      • CTextButton: this class creates a standard text button
      • CGame: this class manages the game logic
      • CInterface: this class controls game GUI that contains texts and buttons
      • CVector2: this class is the handler of vectors
      • CSelectTeam: this class allows the user to select the player
      • CEndPanel: this class shows the panel that will be spawned when all players have arrived to the goal
      • CSwimmer: this class handles what the NPCs has to do
      • CScrollingBg: this class moves the BackGrounds based on the user's player speed
      • CHealtBar: this class handles the graphic energy left
      • CIndicatorController: this class handles the bar spawned during the "turn" animation
      • CMobileControls: this class handles the controls on mobile devices
      • CPrintInfosOnPanel: this class creates the texts on the panel on the right when a player reaches the goal
      • CModeSelect: this class allows the user to select what modality he wants to play
      • CLevelMenu: this class allows the user to select the race to play, this class is used with "CLevelBut" class
      • CLevelBut: this class prints info on the objects of "CLevelMenu" Class
      • CCitySettings: general city settings
      • CShowNationalityInLane: shows flags nationality in each lane
      • CPlayerProgress: this class allows the user to buy PowerUps and to see his position on each City
      • CVariousHelp: this class shows various help, such as "help panel" and "are you sure?" panel
      • CPodiumScreen: Last panel, this will be shown after the last race, and shows the first 3 players on a podium
      • CWater: this class handles the water effects in the pool
    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 clicks the Play button in main menu, the CSelectTeam.js class is called. Then "CModeSelect.js" class will be shown. This class takes the user to the "LevelMenu.js" class that takes the user to "CGame.js" class and the game starts.
    5. If the user clicks 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:

    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