“Sushi Matching” Documentation by “Code This Lab S.r.l.” v1.0

“Sushi Matching”

Created: 02/05/2018
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. Edit a Level
  10. Disable Sounds
  11. Wordpress Plugin

A) Description - top

Sushi Matching is a Premium HTML5 Matching Game. Match three or more identical Sushi pieces and reach the target of each level! Time Stopping hourglasses, bombs and jolly pieces will help you achieving your goal. But be careful, levels will be more and more difficult!

The ZIP package contains the game with 1080x1920 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 Enable 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({
                                        scores_for_single: 30, //Points for single cell destroyed
                                        scores_for_bomb: 100, //Points for bomb destroyed
                                        scores_for_star: 300, //Points for star destroyed
                                        extra_sushi_multiplier: 1.5, //Multiplier applied for extra sushi destroyed

                                        check_orientation:true,     //SET TO FALSE IF YOU DON'T WANT TO SHOW ORIENTATION ALERT ON MOBILE DEVICES
                                        fullscreen:true             //SET THIS TO FALSE IF YOU DON'T WANT TO SHOW FULLSCREEN BUTTON
                                        });

    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 plugin
    5. Screenfull plugin
    6. Hammer 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 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
      • CModeMenu: this class shows the world where the user can select a level
      • CLevelButton: this class manages the level button in level menu selection panel
      • 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
      • CCell: this class manages the cell into the grid
      • CMovingCell: this class manages the sushi movements
      • CParticle: this class manages the particle animations
      • CEndPanel: this class shows the 'end level' panel.
      • CScrollingBg: this class manages scrolling items in the background.
      • CHelpPanel: the help panel that is shown before game starting
      • CLocalStorage: this class manages game savings
      • CLevelSettings: this class manages all levels information. Use it to customize the levels
      • CAreYouSurePanel: this class ensure the confirm to exit from game
      • CCreditsPanel: this class shows the credits
      • CNextLevelPanel: this class shows win panel when level finish
      • CHero: this class manages hero animations
      • CComic: this class manages text animations
      • CFormatText: this class manages text formats
      • CPausePanel: this class manages pause in game
      • CVector2: this class manages vectors in game
      • CVector2: this class manages warning messages
    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.js is a suite that manages the sounds
    5. Screenfull.js manages the fullscreen functionality
    6. Hammer.js manages the touch functionality

    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 level selection panel is shown
    5. After level selection, 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) Edit a Level - top

    You can edit pre-existing levels in CLevelSettings.js file. Each level is declared by this object: 

                                LEVEL_MATRIX[1] = [
                                [0,1,1,1,0],
                                [1,1,1,1,1],
                                [1,1,1,1,1],
                                [1,1,1,1,1],
                                [0,1,1,1,0]
                            ];
                            GOALS[1] = {type0:0, type1:20, type2:0, type3:0, type4:0, type5:0, type6:0, type7:0, star:0, block:0};
                            CONFIG[1] = {time: 60000, numfaces: 3, starallowed: false, bomballowed:false, clockallowed:false, changingallowed: false};
                            BACKGROUND[1] = 2; 
                            TIMER_CLOCK_SPAWN[1] = 0;
                            BEST_SCORE_LIMIT[1] = 4500;

    J) 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;


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