gamegluejs v0.1.0

GameGlueJS (Early Access)

What is GameGlue?

GameGlue is a powerful platform that makes it trivial to build addons to your favorite games with nothing more than a little javascript.

Below is an example showing that with just ~10 lines of code.

Early Access

GameGlue is brand new, and is missing some features. Perhaps, the most obvious is support for the number of games that we'd like. Currently, only Microsoft Flight Simulator - a game near, and dear to my heart - is supported, but as soon as the platform itself is stable, and the user experience, and perhaps more importantly, the developer experience, is at a place we're happy with, we'll begin adding support for more games.

In the meantime, please be patient with us, and be liberal with your feedback, suggestions, etc. Your engagement, ultimately, is what will make GameGlue great.

Getting started

First, click here to sign up for a GameGlue account. Then, head to the Developer Hub to register your app.

Install using one of the following options

NPM

npm i gamegluejs

Yarn

yarn add gamegluejs

Script tag

<script src="https://unpkg.com/gamegluejs@0.0.10/dist/gg.sdk.js"></script>

Initialize the SDK

const ggClient = new GameGlue({
  clientId: '<your-application-id>',
  redirect_uri: '<your-application-url>',
  scopes: ['<your-required-scopes>']
});

Authenticate the user

await ggClient.auth();
const userId = ggClient.getUserId();

Create a listener

const userListener = await ggClient.createListener({
  userId: userId,
  gameId: '<your-game-id>'
});

Use the listener

userListener.on('update', (evt) => {
  document.body.innerHTML = evt.data.ground_speed;
});

That's it!!