“Minigolf World” Documentation by “Code This Lab S.r.l.” v1.0

“Minigolf World”

Created: 06/09/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 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

Minigolf World is a HTML5 Sport Game. Play through the 18 holes of this addicting mini golf. Shoot the ball in all the holes with the least hits possible.

The ZIP package contains the game with 1600x968 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.

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({

                                           stage_par: [             // NUMBER OF SHOTS EXPECTED TO COMPLETE EACH STAGE. THE MORE SHOTS YOU TAKE OVER THE PAR, THE LESS POINTS YOU'LL 
                        
															3,              /// STAGE 1
															3,              /// STAGE 2
															4,              /// STAGE 3
															5,              /// STAGE 4
															4,              /// STAGE 5
															5,              /// STAGE 6
															5,              /// STAGE 7
															5,              /// STAGE 8
															6,              /// STAGE 9
															5,              /// STAGE 10
															5,              /// STAGE 11
															6,              /// STAGE 12
															7,              /// STAGE 13
															8,              /// STAGE 14
															6,              /// STAGE 15
															10,             /// STAGE 16
															7,              /// STAGE 17
															7               /// STAGE 18
											],

											
											par_points: 5000,           //POINT EARNED IF PLAYER SCORES A PAR (BALLS LAUNCHED = BALLS EXPECTED TO COMPLETE A SINGLE LEVEL)
											added_points: 1000,         //POINT TO ADD/SUBTRACT IF PLAYER LAUNCH LESS/MORE BALLS THEN A PAR, RESPECTIVELY.
											max_shot_power: 152,         //MAX POWER OF BALL SHOT (CANNOT BE MORE THEN 160)
											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
      • CGame: this class manages the game logic
      • CInterface: this class controls game GUI that contains text and buttons
      • CAreYouSurePanel: this class ensure the confirm to exit from game
      • CLocalStorage: this class controls persistent data storage
      • CCreditsPanel: this class shows developers credits
      • CHelpPanel: this class shows how-to play the game
      • CEndPanel: this class shows lose game summary
      • CVector2: this class contain vector math operation
      • CTweenController: this class controls tween movement interpolation
      • CLevelButton: this class create a level button
      • CLevelMenu: this class manages level menu selection
      • CNextLevelPanel: this class shows end of a stage summary
      • CBackground: this class manages background, movement and control
      • CBall: this class manages ball sprite and control
      • CLevelCompletePanel: this class shows result of a completed level
      • CLoadingScreen: this class shows loading in progress
      • CRollingTextController: this class manages text animation of the score
      • levelSettings: this class manages settings of each level
      • smoothie: this class shows stats of performance in debug
      • Stats: this class shows stats of performance in debug
      • CAchievementStars: this class manages Star system animation
      • cannon.demo: this class manages physics utility and scene of the game
      • cannon: this class manages physics of the game
      • dat.gui: this class is used by cannon.js
      • Detector: this class is used by cannon.js
      • CScenario: this class manage building of 3D level
      • Three: this class manages 3D camera and view
      • CanvasRenderer: this class is used by Three.js
      • CanvasRenderer: this class is used by Three.js
      • Projector: this class is used by Three.js
      • SoftwareRenderer: this class is used by Three.js
      • TrackballControls: this class is used by Three.js
      • FBXLoader: this class is used to load 3D models in FBX format
      • OBJLoader: this class is used to load 3D models in FBX format
    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 CLevelMenu.js class is called and user can choose a level
    5. If the user click on a level button in level menu, the CGame.js class is called and 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:

    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