aurhe / pg-sdk-js

Phune Gaming SDK for JavaScript

Phune Gaming SDK for JavaScript

Build HTML5 games for the Phune Gaming platform.

Requirements

Building Phune Gaming SDK requires you to have previously installed Node.js.

Build

Install Grunt's command line interface globally:

npm install -g grunt-cli

Install Node.js dependencies:

npm install

Build the SDK:

grunt build

Clean, lint, and build the SDK:

grunt

Generate the API documentation:

grunt docs

There are many other tasks that can be run through Grunt. For the complete list of available tasks run:

grunt --help

Getting Started

In your web page HTML, include the Phune Gaming SDK file:

<script src="PG.min.js"></script>

Initialize the SDK by calling PG.init and define the callback functions that will handle all the matchmaking state changes and game events:

PG.init({
    onMatchPrepare: function(player, opponent, timeToPlay, deviceType) {
        // ...
    },
    onMatchStart: function(playerIdToPlayNext) {
        // ...
    },
    onMoveValid: function(playerIdWhoSentTheMove, playerIdToPlayNext, moveDetails, moveResults, gameResults) {
        // ...
    },
    onMoveInvalid: function(playerIdWhoSentTheMove, playerIdToPlayNext) {
        // ...
    },
    onServerMessage: function(playerIdWhoSentTheMessage, messageDetails, messageResults) {
        // ...
    },
    onPlayerMessage: function(messageDetails) {
        // ...
    },
    onMatchEnd: function(gameResults) {
        // ...
    },
    onKeyPress: function(key) { // TV only
        // ...
    }
});

Please find below a detailed description for each callback.

Match prepare

During the match preparation phase, the game should build the user interface and get ready to start playing. It is provided with the details of the player and opponent, the time allowed for each player to make a move and in which device type the game is running ('mobile' or 'tv').

onMatchPrepare: function(player, opponent, timeToPlay, deviceType) {
    // ...
},

Match start

When the match starts the game will be informed of which player should start playing.

onMatchStart: function(playerIdToPlayNext) {
    // ...
},

Moves handling and validation

If a move is considered valid from the server-side rules, the server will respond with a confirmation message that will be handled by the onMoveValid callback function. Moves performed by the opponent will also be handled by this callback function.

If a move ends the game, the gameResults parameter will indicate how the game ended. Possible values are 'won', 'lost', and 'draw'.

onMoveValid: function(playerIdWhoSentTheMove, playerIdToPlayNext, moveDetails, moveResults, gameResults) {
    // ...
},

If a move does not pass the server-side rules validation, the game will be notified by the onMoveInvalid callback function.

onMoveInvalid: function(playerIdWhoSentTheMove, playerIdToPlayNext) {
    // ...
},

Handle messages from the server

Responses to messages sent to the server will be processed by the onServerMatch callback function.

onServerMessage: function(playerIdWhoSentTheMessage, messageDetails, messageResults) {
    // ...
},

Handle messages from an opponent

Messages sent by the opponent will be processed by the onPlayerMessage callback function.

onPlayerMessage: function(messageDetails) {
    // ...
},

Match end

When the game ends, the onMatchEnd callback function is called with the end condition. Possible values are 'won', 'lost', and 'draw'.

onMatchEnd: function(gameResults) {
    switch (gameResults) {
    case 'won':
        // ...
        break;
    case 'lost':
        // ...
        break;
    default:
        // draw...
        break;
    }
},

TV remote control input handling

On TV environment, the information of remote control buttons that were pressed, are sent to the game to be handled by the onKeyPress callback function. Possible values are: 'left', 'right', 'up', 'down' and 'enter'.

onKeyPress: function(key) {
    switch(key) {
    case 'left':
        // ...
        break;
    case 'right':
        // ...
        break;
    case 'up':
        // ...
        break;
    case 'down':
        // ...
        break;
    case 'enter':
        // ...
        break;
    }
}

Public API

The Phune Gaming SDK provides an API with the public methods as detailed below.

Match start

During the match preparation phase (onMatchPrepare callback) the game must inform the platform when it is ready to be shown to the user and when it is ready to start the match. For starting a match both functions PG.prepared and PG.ready below must be called.

The game interface can be shown to the user by calling the function PG.prepared.

PG.prepared();

If the game requires some sort of configuration, additional messages need to be sent to the server by calling PG.serverMessage after calling PG.prepared but before PG.ready.

When the game is finally ready to start the match, it should call PG.ready. If PG.prepared was not called previously, the game will not be shown to the user.

PG.ready();

Send messages to the server

It is possible to send messages to be evaluated by the server-side rules. You can specify if you want the response to be sent to both players or only to yourself. Additionally you can also indicate if you want the messages to be processed by the server-side rules in order of arrival or in parallel.

PG.serverMessage(
    messageObject,    // any message content can be passed here
    false,            // should the response be sent to both players?
    true              // should the message be processed by the order of arrival?
);

Send messages to the opponent

If the game requires to send messages to the opponent that should not be evaluated by the server-side rules, it can use this function. Optionally, you can specify if you do not want to allow more than one message to be sent within the specified time in milliseconds. If this is called more than once during this interval only the last message will be sent.

PG.playerMessage(
    messageObject,    // any message content can be passed here
    150               // do not send more than one message during this interval
);

Perform a move

If it is the current player turn, the game should allow the player to make a move and then send it to the platform. Optionally, you can specify a validate function that accepts the move object as a parameter and validates it before sending it to the server. This prevents additional round-trips to the server for invalid moves, thus making the game a lot more responsive.

PG.move(
    moveObject,         // any move details can be passed here
    validateFunction    // function to validate the move
);

Show the platform menu

The game must include a visual component allowing a user to call for the platform menu. In order to show the menu that component must call the function PG.showMenu.

PG.showMenu();

License

Copyright (c) 2014 Present Technologies

Licensed under the MIT license.