From 1463cacfa6a895d3d774ffeb3d27aa5cf0344c4a Mon Sep 17 00:00:00 2001 From: jbillmann Date: Mon, 22 Jul 2013 17:51:44 -0500 Subject: [PATCH] Update README.md --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 75c1e7d..ef4600f 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,42 @@ A simple, lightweight, HTML multiplayer game server (and client) for Node.js ### Client +```js +GarageServerIO.initializeGarageServer(path, options) + +options = { + onPlayerConnect(callback), + onPlayerDisconnect(callback), + onPlayerReconnect(callback), + onPlayerUpdate(callback(state)), + onEntityUpdate(callback(state)), + onPlayerRemove(callback(id)), + onEntityRemove(callback(id)), + onEvent(callback(data)), + onWorldState(callback(state)), + onPing(callback(pingDelay)), + onUpdatePlayerPhysics(callback(state, inputs, deltaTime)), + onInterpolation(callback(previousState, targetState, amount)), + onReady(callback, + logging: true +} +``` + +```js +GarageServerIO.addInput(input) +``` + +```js +GarageServerIO.getStates(callback(playerStates: [player1State, player2State, ...], entityStates: [entity1State, entity2State, ...])) +``` + +```js +GarageServerIO.getId() : 'playerid' +``` + +```js +GarageServerIO.sendServerEvent(data) +``` ### Server