@alliumcloud/realtime-engine

SDK for the Allium Realtime Engine (RTE) service — provision and manage game servers via an SDK key.

Install

npm install @alliumcloud/realtime-engine

Usage

import RTE from "@alliumcloud/realtime-engine";

const rte = new RTE({
  sdkKey: "your-sdk-key",
  // serverUrl: "http://localhost:5000/api/v1", // optional override of the baked-in URL
});

// create a game server
const server = await rte.serverCreate({
  userId: "user-123",
  pvcName: "my-pvc",
  ueImage: "registry.example.com/ue-game:latest",
  spaceId: "space-1",
  roomId: "room-1",
  region: "LAS1",
  cpu: "4000m",
  memory: "16Gi",
  gpuCount: 1,
  gpuClass: "Quadro_RTX_4000",
  env: { FOO: "bar" },
});

// fetch
const one = await rte.serverGetById(server.id);
const all = await rte.serverGetAll({ spaceId: "space-1" });

// delete
await rte.serverDelete(server.id);