@netforge/kit-play API reference

import { play, TEMPLATES } from "@netforge/kit-play";

function check(o: CheckOptions): Promise<CheckResult>;

function namesModule(n: Names, templateNamesPath: string): string;

function parseNames(text: string): Names;

function play(o: PlayOptions): Promise<Playing>;

function readGameFolder(dir: string): GameFolder;

function runKitPlayCli(argv: readonly string[], io: PlayCliIo): Promise<number>;

function runPlayCli(argv: readonly string[], io: PlayCliIo): Promise<number>;

function runTestCli(argv: readonly string[], io: PlayCliIo): Promise<number>;

function summary(r: CheckResult): string[];

function templateFor(name: unknown): TemplateEntry | null;

class PlayError {
  constructor(message?: string);
}

const ALLOWED_IMPORT: "@netforge/engine";

const COMMANDS_HELP: "kit-play: make, test and play Net Forge games on this computer with play money.\n\nUsage:\n  kit-play play [dir] [flags]       Build the game in dir (default: here) and play it. kit-play play --help for flags.\n  kit-play test [dir] [flags]       Compile src/game.ts and run the playtest bots, no browser.\n  kit-play check [dir] [flags]      The same, with the report as JSON on stdout.\n  kit-play new [folder] [flags]     Start a new game from a template (the same as npm create netforge).\n  kit-play templates [--json]       List the templates.\n\nkit-play [dir] without a command plays, as bef /* ... */;

const HELP: "kit play: run a Net Forge game on this computer with play money.\n\nUsage: kit play [dir] [flags]     (inside the folder you downloaded from Net Forge)\n\n  --port <n>          Port for the page and the local room (default 4663).\n  --host <addr>       Interface to listen on (default 127.0.0.1, this computer only).\n                      Use 0.0.0.0 to let devices on your network join.\n  --players <n>       Browser tabs to open, one per local player (default 1).\n  --no-open           Print the link instead of opening a browser.\n  --library-url <u>   Load the asset library from this URL ins /* ... */;

const TEMPLATES: Readonly<Record<TemplateId, TemplateEntry>>;

const TEST_HELP: "kit-play test: compile src/game.ts as the play build does and run the playtest bots.\n\nUsage: kit-play test [dir] [flags]\n\n  --minutes <n>   Minutes of game time the bots play, at the template's own tick rate (default 1, up to 30).\n  --bots <n>      Bots playing (default: 2, or fewer when the template seats fewer).\n  --seed <n>      Random seed (default 1).\n  --json          Print the result as JSON on stdout.\n\nExits 0 when the game compiles and every playtest check passes, 1 otherwise.";

interface CheckOptions {
  readonly dir: string;
  readonly minutes: number;
  readonly bots: number | null;
  readonly seed: number;
  readonly log: (s: string) => void;
}

interface CheckReport {
  readonly ticks: number;
  readonly bots: number;
  readonly kills: number;
  readonly deaths: number;
  readonly wave: number;
  readonly maxLevel: number;
  readonly earnEmitted: number;
  readonly earned: Readonly<Record<string, number>>;
  readonly softlock: boolean;
  readonly msPerTick: number;
  readonly rules?: { readonly template: string; readonly checks: readonly { readonly ok: boolean; readonly line: string }[]; readonly progress: number };
  readonly failed: readonly string[];
}

interface CheckResult {
  readonly ok: boolean;
  readonly template: string;
  readonly problems: readonly string[];
  readonly tickRate?: number;
  readonly report: CheckReport | null;
}

interface GameFolder {
  readonly dir: string;
  readonly template: TemplateEntry;
  readonly gameFile: string;
  readonly names: Names | null;
}

interface Names {
  readonly title: string;
  readonly weapons: Readonly<Record<string, { readonly name: string; readonly line: string }>>;
  readonly upgrades: Readonly<Record<string, { readonly name: string; readonly line: string }>>;
  readonly enemies: Readonly<Record<string, string>>;
  readonly rules: Readonly<Record<string, string>>;
  readonly skus: Readonly<Record<string, string>>;
}

interface PlayCliIo {
  out(s: string): void;
  err(s: string): void;
  cwd: string;
}

interface Playing {
  readonly url: string;
  readonly lan: readonly string[];
  close(): Promise<void>;
}

interface PlayOptions {
  readonly dir: string;
  readonly port: number;
  readonly host: string;
  readonly open: boolean;
  readonly players: number;
  readonly libraryUrl: string | null;
  readonly log: (s: string) => void;
}

interface TemplateEntry {
  readonly id: TemplateId;
  readonly label: string;
  readonly pkg: string;
  readonly adapter: string;
  readonly manifest: { readonly fn: string; readonly field?: "manifest" };
  readonly seats: number;
  readonly aoi: LocalAoi;
}

type TemplateId = "survivor" | "arena" | "tower-defense" | "dungeon" | "idle" | "platformer" | "cards" | "collector" | "racer" | "party";