Introduction

This document provides a high level guideline on specific requirements for developing H5 games that can be integrated with the Orange Games tournament platform, powered by Goama.

Basic requirements

1. The games should be delivered in HTML5 and any javascript files combined in one file that is minified and obfuscated
2. The uncompressed size of the payload should be less than 7 MB
3. The package should be hostable in a web server
4. The games should be able to work in full screen mode
5. Games should be able to include SDK provided by GoGames and interact with the SDK to communicate with the Tournament Platform

Installing SDK

You can install the SDK from goama in two ways.

Use the Build File

Goama SDK can be installed in a game by including the build file into the games HTML page.

The build file is **available here.

Github link**

Use the Javascript Package

The SDK can be included in the games through npm/yarn installation.

Install the package with the below command:

npm install gg-game-sdk

Game interaction with the Tournament Platform

The H5 game will be hosted in an iFrame within an HTML document. The SDK provides methods for communicating with the parent window. Functionalities like creating/updating game and user specific data - e.g. high scores, perks earned etc, letting the Tournament Platform know that a game has ended, paused or resumed etc. and listening to events passed on from the parent window, like pause, resume, quit etc.

Retrieving User Game Data