@gamedistribution.com/html5-sdk v0.0.5

Gamedistribution.com HTML5 API

This is the documentation of the "Gamedistribution.com HTML5 API" project.

Gamedistribution.com is the biggest broker of high quality, cross-platform games. We connect the best game developers to the biggest publishers.

Running into any issues? Check out the F.A.Q. within the Wiki of the github repository before mailing to support@gamedistribution.com

Implementation within games

The API should be integrated within HTML5 games by simple import as npm package OR loading it through our CDN. Specific information of the API features and usages can be found at the wiki.

ES5 Import

Import the npm package from https://www.npmjs.com/package/@gamedistribution.com/html5-sdk.

import GameDistribution from '@gamedistribution.com/html5-sdk';

CDN

Or add this script to your document.

<script src="//html5.api.gamedistribution.com/main.js"></script>

Legacy - Don't use this, only available for old implementations.

The index.html of this project contains a legacy integration example of the old HTML5 API.

<script src="//html5.api.gamedistribution.com/libs/gd/api.js"></script>

Debugging

Games, which include the API, can be easily debugged by calling the following from a browser developer console:

gdApi.openConsole();

The gdApi namespace is set when creating the api instance. We can't change the name of this namespace as it is still used within games using the old API implementation.

Repository

The API is maintained on a public github repository. https://github.com/GameDistribution/GD-HTML5

Deployment

Deployment of the API to production environments and npmjs.com is done through TeamCity. The npm package is published as ES5 for backward compatibility support using a prepublish Babel task defined within package.json, even though our repository uses ES6.

Installation for development

Install the following programs:

• NodeJS LTS.
• Grunt.

Pull in the rest of the requirements using npm:

npm install

Setup a local node server, watch changes and update your browser view automatically:

grunt

Make a production build for the CDN solution. The npmjs version uses a "prepublish"-task defined within package.json, which does a simple babel task, similar to this task:

grunt build

Events

API EVENTS

The API events should be used by developers to start or pause their game or handling critical errors. Unless the errors are ad related, then they could hook into the AD_ERROR event, however; the API should gracefully fail, so this should not be needed.

IMA SDK EVENTS

The SDK events are custom ads for handling any thing related to the IMA SDK itself.

AD EVENTS

The Gamedistribution.com API uses the IMA SDK for loading ads. All events of this SDK are also available to the developer. https://developers.google.com/interactive-media-ads/docs/sdks/html5/