Trail-client-sdk NPM

Trail Client SDK

This is the SDK which lives together with the game client and acts as a bridge between the game and the Trail Platform.

Assumptions

The SDK lives inside an iframe next to the game-client on the Trail Platform.
The SDK is included in the source document through either a <script> tag or is bundled directly with the source files, likely installed through the means of npm or bower.
Initialisation of the SDK is on an opt-in base by the developer. Merely including the SDK should never result in initialisation.

Usage

Installation

Install the SDK in your project:

npm install trail-client-sdk --save

Including the script

// ES6 import syntax
import TrailSDK from 'trail-client-sdk';

// ES5 module/require syntax
const TrailSDK = require('trail-client-sdk');

Initialising the SDK

Before you can start using the SDK you must call the init() method:

// Initialise the SDK, allowing it to get set-up with the Trail Platform
TrailSDK.init().then((trail) => {
  // Print logged in user's username
  console.log('Hello there, %s!', trail.user.username);

  // Connect to a Pigeoneer-enabled gameserver
  const connection = trail.net.connectTo({ host: 'localhost', port: 9500 });

  connection.onOpen = () => {
    console.info('The connection has been established.');
  };

  connection.onStreamMessage = (message) => {
    // pass incoming message to your game
  };

  // Update game downloading progress to 40%
  trail.game.setLoadingProgress(0.4);

  // Listen for changes to the user
  trail.on('user_updated', () => {
    console.log('Got yourself an update, %s?', trail.user.username);
  });
});

Alternatively, you can install the latest version through the unpkg CDN:

<script async src="https://unpkg.com/trail-client-sdk/dist/trail.web.js"></script>
<script>
  // Synchronously loaded
  TrailSDK.init().then(function(trail) {
    // ...
  });

  // Asynchronously loaded  
  window.trailAsyncInit = function(TrailSDK) {
    TrailSDK.init().then(function(trail) {
      // ...
    });
  };
</script>