Miss any of our Open RFC calls?Watch the recordings here! »

@geckos.io/snapshot-interpolation

1.0.1 • Public • Published
logo

Snapshot Interpolation

A Snapshot Interpolation library for Real-Time Multiplayer Games

Easily add Snapshot Interpolation (also called Entity Interpolation or Buffer Interpolation) to your Games.

NPM version Github Workflow GitHub last commit Downloads Codecov build with TypeScript


About

The Interpolation Buffer is by default 3 server frames long (Interpolation between 4 Snapshots). So if the latency is 50ms and one server frame is 50ms, the Interpolation Buffer would be 200ms long.

If you are interested to learn a bit more about Snapshot Interpolation, watch this video.

Features

  • Easily add Client-Side Prediction and Server Reconciliation.
  • Easily add Lag Compensation.
  • Easily compress/encode your snapshots before sending/receiving.

Introduction

Take a look at these YouTube videos:

Game Example

The github repository contains a nice example. Take a look!

# clone the repo 
$ git clone https://github.com/geckosio/snapshot-interpolation.git
 
# cd into it 
cd snapshot-interpolation
 
# install all dependencies 
$ npm install
 
# start the example 
$ npm start

Install

Install from npm.

npm install @geckos.io/snapshot-interpolation

Or use the bundled version.

<script src="https://unpkg.com/@geckos.io/snapshot-interpolation@1.0.1/bundle/snapshot-interpolation.js"></script>
<script>
  const { SnapshotInterpolation, Vault } = Snap
</script> 

How to use

server.js

// import @geckos.io/snapshot-interpolation
import { SnapshotInterpolation } from '@geckos.io/snapshot-interpolation'
 
// initialize the library
const SI = new SnapshotInterpolation()
 
// your server update loop
update() {
  // create a snapshot of the current world
  const snapshot = SI.snapshot.create(worldState)
 
  // add the snapshot to the vault in case you want to access it later (optional)
  SI.vault.add(snapshot)
 
  // send the snapshot to the client (using geckos.io or any other library)
  this.emit('update', snapshot)
}

client.js

// import @geckos.io/snapshot-interpolation
import { SnapshotInterpolation } from '@geckos.io/snapshot-interpolation'
 
// initialize the library (add your server's fps)
const SI = new SnapshotInterpolation(serverFPS)
 
// when receiving the snapshot on the client
this.on('update', (snapshot) => {
  // read the snapshot
  SI.snapshot.add(snapshot)
}
 
// your client update loop
update() {
  // calculate the interpolation for the parameters x and y and return the snapshot
  const snapshot = SI.calcInterpolation('x y') // [deep: string] as optional second parameter
 
  // access your state
  const { state } = snapshot
 
  // apply the interpolated values to you game objects
  const { id, x, y } = state[0]
  if (hero.id === id) {
    hero.x = x
    hero.y = y
  }
}

World State

The World State has to be an Array with non nested Objects (expect for Quaternions). You can name you keys as you want. For degree, radian or quaternion values add key(deg), key(rad) or key(quat).

Linear Interpolation

// the worldState on the server
const worldState = [
  { id: 'heroBlue', x: 23, y: 14, z: 47 },
  { id: 'heroRed', x: 23, y: 14, z: 47 },
  { id: 'heroGreen', x: 23, y: 14, z: 47 }
]
 
// calc interpolation on the client
SI.calcInterpolation('x y z')

Degrees, Radians and Quaternions

// the worldState on the server
const worldState = [
  {
    id: 'myHero',
    direction: Math.PI / 2,
    rotationInDeg: 90,
    q: { x: 0, y: 0.707, z: 0, w: 0.707 }
  }
]
 
// calc interpolation on the client
SI.calcInterpolation('direction(rad) rotationInDeg(deg) q(quat)')

Multiple States

// the players state
const playersState = [
  { id: 0, x: 65, y: -17 },
  { id: 1, x: 32, y: 9 }
]
 
// the towers state
const towersState = [
  { id: 0, health: 100, type: 'blizzardCannon' },
  { id: 1, health: 89, type: 'flameThrower' }
]
 
const worldState = {
  players: playersState,
  towers: towersState
}
 
// create snapshot
SI.snapshot.create(worldState)
 
// we only want to interpolate x and y on the players object
SI.calcInterpolation('x y', 'players')

Vault

The Vault holds and secures all your Snapshots. Each SnapshotInterpolation instance holds one Vault, but you can easily create more if you need:

import { Vault } from '@geckos.io/snapshot-interpolation'
 
const customVault = new Vault()

Compression

You can use the package @geckos.io/typed-array-buffer-schema to compress your snapshots before sending them to the client.

// schema.js
const playerSchema = BufferSchema.schema('player', {
  id: uint8,
  x: { type: int16, digits: 1 },
  y: { type: int16, digits: 1 }
})
 
const snapshotSchema = BufferSchema.schema('snapshot', {
  id: { type: string8, length: 6 },
  time: uint64,
  state: { players: [playerSchema] }
})
 
export const snapshotModel = new Model(snapshotSchema)
 
// server.js
const snapshot = SI.snapshot.create({
  players: [
    { id: 0, x: 17.5, y: -1.1 },
    { id: 1, x: 5.8, y: 18.9 }
  ]
})
 
const buffer = snapshotModel.toBuffer(snapshot)
send(buffer)
 
// client.js
receive(buffer => {
  snapshot = snapshotModel.fromBuffer(buffer)
  SI.addSnapshot(snapshot)
})

API

This looks very TypeScriptisch, but you can of course use it in JavaScript as well.

// import
import { SnapshotInterpolation, Vault, Types } from '@geckos.io/snapshot-interpolation'
 
// types
type Value = number | string | Quat | undefined
type ID = string
type Time = number
type State = Entity[]
type Quat = { x: number; y: number; z: number; w: number }
 
// interfaces
export interface Entity {
  id: string
  [key: string]: Value
}
export interface Snapshot {
  id: ID
  time: Time
  state: State | { [key: string]: State }
}
export interface InterpolatedSnapshot {
  state: State
  percentage: number
  older: ID
  newer: ID
}
 
// static methods
/** Create a new Snapshot */
SnapshotInterpolation.CreateSnapshot(stateState)Snapshot
 
/** Create a new ID */
SnapshotInterpolation.NewId()string
 
/** Get the current time in milliseconds. */
SnapshotInterpolation.Now()number
 
// class SnapshotInterpolation
const SI = new SnapshotInterpolation(serverFPS?: number)
 
/** Access the vault. */
SI.vaultVault
 
/** Get the Interpolation Buffer time in milliseconds. */
SI.interpolationBuffer.get()number
 
/** Set the Interpolation Buffer time in milliseconds. */
SI.interpolationBuffer.set(millisecondsnumber)void
 
/** Create the snapshot on the server. */
SI.snapshot.create(stateState)Snapshot
 
/** Add the snapshot you received from the server to automatically calculate the interpolation with calcInterpolation() */
SI.snapshot.add(snapshotSnapshot)void
 
/** Interpolate between two snapshots give the percentage or time. */
SI.interpolate(snapshotASnapshot, snapshotBSnapshot, timeOrPercentagenumber, parametersstring, deepstring)InterpolatedSnapshot
 
/** Get the calculated interpolation on the client. */
SI.calcInterpolation(parametersstring, deepstring)InterpolatedSnapshot | undefined
 
// class Vault
const vault = new Vault()
 
/** Get a Snapshot by its ID. */
vault.getById(idID)Snapshot
 
/** Get the latest snapshot */
vault.get()Snapshot | undefined;
 
/** Get the two snapshots around a specific time */
vault.get(timenumber){ olderSnapshot; newerSnapshot; } | undefined
 
/** Get the closest snapshot to e specific time */
vault.get(timenumber, closestboolean)Snapshot | undefined
 
/** Add a snapshot to the vault. */
vault.add(snapshotSnapshot)void
 
/** Get the current capacity (size) of the vault. */
vault.size()number
 
/** Set the max capacity (size) of the vault. */
vault.setMaxSize(sizenumber)void
 
/** Get the max capacity (size) of the vault. */
vault.getMaxSize()number
 

Install

npm i @geckos.io/snapshot-interpolation

DownloadsWeekly Downloads

16

Version

1.0.1

License

BSD-3-Clause

Unpacked Size

157 kB

Total Files

25

Homepage

geckos.io

Last publish

Collaborators

  • avatar