@takaro/gameserver 0.0.0-next.0da151e

package/src/getGame.ts

@@ -0,0 +1,34 @@
+import { errors } from '@takaro/util';
+import { GameServerOutputDTOTypeEnum, Settings } from '@takaro/apiclient';
+import { SdtdConnectionInfo } from './gameservers/7d2d/connectionInfo.js';
+import { SevenDaysToDie } from './gameservers/7d2d/index.js';
+import { RustConnectionInfo } from './gameservers/rust/connectionInfo.js';
+import { Rust } from './gameservers/rust/index.js';
+import { IGameServer } from './interfaces/GameServer.js';
+import { GenericConnectionInfo } from './gameservers/generic/connectionInfo.js';
+import { Generic } from './gameservers/generic/index.js';
+
+export enum GAME_SERVER_TYPE {
+  'SEVENDAYSTODIE' = 'SEVENDAYSTODIE',
+  'RUST' = 'RUST',
+  'GENERIC' = 'GENERIC',
+  'MOCK' = 'MOCK',
+}
+
+export async function getGame(
+  type: GAME_SERVER_TYPE | GameServerOutputDTOTypeEnum,
+  connectionInfo: Record<string, unknown>,
+  settings: Partial<Settings>,
+  gameServerId: string,
+): Promise<IGameServer> {
+  switch (type) {
+    case GAME_SERVER_TYPE.SEVENDAYSTODIE:
+      return new SevenDaysToDie(new SdtdConnectionInfo(connectionInfo), settings);
+    case GAME_SERVER_TYPE.RUST:
+      return new Rust(new RustConnectionInfo(connectionInfo), settings);
+    case GAME_SERVER_TYPE.GENERIC:
+      return new Generic(new GenericConnectionInfo(connectionInfo), settings, gameServerId);
+    default:
+      throw new errors.NotImplementedError();
+  }
+}

package/src/interfaces/GameServer.ts

@@ -0,0 +1,215 @@
+import { TakaroEmitter } from '../TakaroEmitter.js';
+import { IGamePlayer, IPosition } from '@takaro/modules';
+import { TakaroDTO } from '@takaro/util';
+import {
+  IsBoolean,
+  IsEnum,
+  IsISO8601,
+  IsNumber,
+  IsObject,
+  IsOptional,
+  IsString,
+  ValidateNested,
+} from 'class-validator';
+import { Type } from 'class-transformer';
+
+export class CommandOutput extends TakaroDTO<CommandOutput> {
+  @IsString()
+  rawResult: string;
+  @IsBoolean()
+  success: boolean;
+  @IsOptional()
+  @IsString()
+  errorMessage?: string;
+}
+export class TestReachabilityOutputDTO extends TakaroDTO<TestReachabilityOutputDTO> {
+  @IsBoolean()
+  connectable: boolean;
+
+  @IsString()
+  @IsOptional()
+  reason?: string;
+
+  @IsOptional()
+  @IsNumber()
+  latency?: number;
+}
+
+/**
+ * This is used whenever we want to target a specific player
+ * We only allow a subset of IGamePlayer here because to work across gameservers we need to be generic
+ * Eg, if we allow users to reference players by Steam ID, that wont work for all gameservers. Not all gameservers have Steam integration
+ */
+export class IPlayerReferenceDTO extends TakaroDTO<IPlayerReferenceDTO> {
+  @IsString()
+  gameId: string;
+}
+
+export class IItemDTO extends TakaroDTO<IItemDTO> {
+  @IsString()
+  name: string;
+  @IsString()
+  code: string;
+  @IsString()
+  @IsOptional()
+  description: string;
+  @IsNumber()
+  @IsOptional()
+  amount?: number;
+  @IsString()
+  @IsOptional()
+  quality?: string;
+}
+
+export class IMessageOptsDTO extends TakaroDTO<IMessageOptsDTO> {
+  @Type(() => IPlayerReferenceDTO)
+  @ValidateNested()
+  @IsOptional()
+  /** When specified, will send a DM to this player instead of a global message */
+  recipient?: IPlayerReferenceDTO;
+
+  @IsString()
+  @IsOptional()
+  /** When specified, overrides the server chat name from settings */
+  senderNameOverride?: string;
+}
+
+export class BanDTO extends TakaroDTO<BanDTO> {
+  @Type(() => IGamePlayer)
+  @ValidateNested()
+  player: IGamePlayer;
+
+  @IsString()
+  reason: string;
+
+  @IsISO8601()
+  @IsOptional()
+  expiresAt: string | null;
+}
+
+export class MapInfoDTO extends TakaroDTO<MapInfoDTO> {
+  @IsBoolean()
+  enabled: boolean;
+  @IsNumber()
+  mapBlockSize: number;
+  @IsNumber()
+  maxZoom: number;
+  @IsNumber()
+  mapSizeX: number;
+  @IsNumber()
+  mapSizeY: number;
+  @IsNumber()
+  mapSizeZ: number;
+}
+
+export enum EntityType {
+  HOSTILE = 'hostile',
+  FRIENDLY = 'friendly',
+  NEUTRAL = 'neutral',
+}
+
+export class IEntityDTO extends TakaroDTO<IEntityDTO> {
+  @IsString()
+  code: string;
+  @IsString()
+  name: string;
+  @IsString()
+  @IsOptional()
+  description: string;
+  @IsEnum(Object.values(EntityType))
+  @IsOptional()
+  type: EntityType;
+  @IsObject()
+  @IsOptional()
+  metadata?: Record<string, unknown>;
+}
+
+export class ILocationDTO extends TakaroDTO<ILocationDTO> {
+  @ValidateNested()
+  @Type(() => IPosition)
+  position: IPosition;
+  @IsNumber()
+  @IsOptional()
+  radius?: number; // For circular areas, radius in game units
+  @IsNumber()
+  @IsOptional()
+  sizeX?: number; // For rectangular areas, X dimension
+  @IsNumber()
+  @IsOptional()
+  sizeY?: number; // For rectangular areas, Y dimension
+  @IsNumber()
+  @IsOptional()
+  sizeZ?: number; // For rectangular areas, Z dimension (height)
+  @IsString()
+  name: string;
+  @IsString()
+  @IsOptional()
+  code?: string;
+  @IsObject()
+  @IsOptional()
+  metadata?: Record<string, unknown>;
+}
+
+export interface IGameServer {
+  connectionInfo: unknown;
+  getEventEmitter(): TakaroEmitter;
+
+  getPlayer(player: IPlayerReferenceDTO): Promise<IGamePlayer | null>;
+  getPlayers(): Promise<IGamePlayer[]>;
+  getPlayerLocation(player: IPlayerReferenceDTO): Promise<IPosition | null>;
+  getPlayerInventory(player: IPlayerReferenceDTO): Promise<IItemDTO[]>;
+
+  giveItem(player: IPlayerReferenceDTO, item: string, amount: number, quality?: string): Promise<void>;
+  listItems(): Promise<IItemDTO[]>;
+
+  listEntities(): Promise<IEntityDTO[]>;
+  listLocations(): Promise<ILocationDTO[]>;
+
+  executeConsoleCommand(rawCommand: string): Promise<CommandOutput>;
+  sendMessage(message: string, opts: IMessageOptsDTO): Promise<void>;
+  teleportPlayer(player: IPlayerReferenceDTO, x: number, y: number, z: number, dimension?: string): Promise<void>;
+
+  /**
+   * Try and connect to the gameserver
+   * If anything goes wrong, this function will report a detailed reason
+   */
+  testReachability(): Promise<TestReachabilityOutputDTO>;
+
+  kickPlayer(player: IPlayerReferenceDTO, reason: string): Promise<void>;
+
+  banPlayer(options: BanDTO): Promise<void>;
+  unbanPlayer(player: IPlayerReferenceDTO): Promise<void>;
+  listBans(): Promise<BanDTO[]>;
+  shutdown(): Promise<void>;
+
+  getMapInfo(): Promise<MapInfoDTO>;
+  // Returns a base64 encoded image of the map tile
+  getMapTile(x: number, y: number, z: number): Promise<string>;
+}
+
+// All actions that can be sent to the gameserver
+// So the IGameServer interface, but with some internal types omitted
+export type GameServerActions = keyof Omit<IGameServer, 'getEventEmitter' | 'connectionInfo'>;
+// Also create a runtime array with all the actions
+// This is used for class-validator
+export const GAME_SERVER_ACTIONS: GameServerActions[] = [
+  'getPlayer',
+  'getPlayers',
+  'getPlayerLocation',
+  'getPlayerInventory',
+  'giveItem',
+  'listItems',
+  'listEntities',
+  'listLocations',
+  'executeConsoleCommand',
+  'sendMessage',
+  'teleportPlayer',
+  'testReachability',
+  'kickPlayer',
+  'banPlayer',
+  'unbanPlayer',
+  'listBans',
+  'shutdown',
+  'getMapInfo',
+  'getMapTile',
+];

package/src/main.ts

@@ -0,0 +1,16 @@
+export * from './interfaces/GameServer.js';
+
+export { TakaroEmitter } from './TakaroEmitter.js';
+
+export { SevenDaysToDie } from './gameservers/7d2d/index.js';
+export { SdtdConnectionInfo, sdtdJsonSchema } from './gameservers/7d2d/connectionInfo.js';
+
+export { Rust } from './gameservers/rust/index.js';
+export { RustConnectionInfo, rustJsonSchema } from './gameservers/rust/connectionInfo.js';
+
+export { getGame, GAME_SERVER_TYPE } from './getGame.js';
+
+export { Generic } from './gameservers/generic/index.js';
+export { TakaroConnector } from './gameservers/generic/connectorClient.js';
+export { GenericEmitter } from './gameservers/generic/emitter.js';
+export { GenericConnectionInfo, genericJsonSchema } from './gameservers/generic/connectionInfo.js';

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["src/**/*.test.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist"]
+}

package/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/main.ts"]
+}