“FatBoy Dream” Documentation by “Code This Lab S.r.l.” v1.0
“FatBoy Dream”
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
- Description
- Folder Contents
- Getting Started
- HTML Structure
- CSS Files and Structure
- Source Code
- Game functions
- Change Graphic
- Disable Sounds
- Wordpress Plugin
A) Description - top
FatBoy Dream is a HTML5 Skill Game.
Jump from donut to donut and bounce on the walls to eat as many flying donuts as you can!
The ZIP package contains the game with 1120X1400 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
var TEXT_ARE_SURE = "ARE YOU SURE?";
var TEXT_CREDITS_DEVELOPED ="DEVELOPED BY";
var TEXT_ERR_LS = "YOUR WEB BROWSER DOES NOT SUPPORT STORING SETTING LOCALLY. IN SAFARI, THE MOST COMMON CAUSE OF THIS IS USING 'PRIVATE BROWSING MODE'. SOME INFO MAY NOT SAVE OR SOME FEATURE MAY NOT WORK PROPERLY.";
var TEXT_HELP = "JUMP FROM DONUT TO DONUT AND BOUNCE ON THE WALLS TO EAT AS MANY FLYING DONUTS AS YOU CAN!";
var GAME_OVER_LABELS = ["RETRY",
"TRY AGAIN!"];
var GAME_WIN_LABELS = ["GREAT!",
"FANTASTIC!",
"AMAZING!"];
var TEXT_BEST_SCORE = "BEST SCORE";
var TEXT_YOUR_SCORE = "YOUR SCORE";
var TEXT_PRELOADER_CONTINUE = "START";
var TEXT_SHARE_IMAGE = "200x200.jpg";
var TEXT_SHARE_TITLE = "Congratulations!";
var TEXT_SHARE_MSG1 = "You collected ";
var TEXT_SHARE_MSG2 = " points!
Share your score with your friends!";
var TEXT_SHARE_SHARE1 = "My score is ";
var TEXT_SHARE_SHARE2 = " points! Can you do better";
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({
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:
- jQuery
- Our custom scripts
- CreateJs plugin
- Howler
- 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
- 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
- CPlanet: this class manages the single planet(donut) rotation and type.
- CPlanetManager: this class handle the rearrangement of the planets (donuts).
- CEndPanel: this class is a simple panel that show you score at the end of the game.
- CHelpPanel: this class is a simple panel that show how to play.
- CAreYouSurePanel: this class is a simple panle that show you a message to be sure that you want to exit
- CCreditsPanel: this class is a simple panel that display info about the creator of the game.
- CStar: this class manages the single star (flying donut) collision and type.
- CStarManager: this class handles the position of the group of star being spawned and manages the pattern.
- CWall: this class manages the wall on the side of the screen.
- CParallax: this class manages the parallax effect on the background and walls.
- CCharacter: this class manage the character in game, and handles his animations and sounds.
- CVector2: this class controls all the calculation on Vectors.
- CreateJs is a suite of modular libraries and tools which work together to enable rich interactive content on open web technologies via HTML5.
- Howler is a library that manages audio.
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 game starts
- CGame.js creates than the stage, and call the main game loop using the Update() function
- In the main game loop are handled the graphics to show and animate
- If the user click on the exit button in the up-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 starts all the classes needed in game.
- getScore()
This function returns the current score.
- cameraFollowCharacter()
This function handle the camera movement when the player has reached the planet(donut).
- handleStars()
This function is used to decide when the stars need to be spawned and communicate with the CStarManager.
- unload
This function is called when user want to exit from the game.
- update()
This function manages the main game loop and handle the calculation on the physics.
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