@takaro/gameserver 0.0.1

package/src/getGame.ts

@@ -0,0 +1,32 @@
+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 { MockConnectionInfo } from './gameservers/mock/connectionInfo.js';
+import { Mock } from './gameservers/mock/index.js';
+import { RustConnectionInfo } from './gameservers/rust/connectionInfo.js';
+import { Rust } from './gameservers/rust/index.js';
+import { IGameServer } from './interfaces/GameServer.js';
+
+export enum GAME_SERVER_TYPE {
+  'MOCK' = 'MOCK',
+  'SEVENDAYSTODIE' = 'SEVENDAYSTODIE',
+  'RUST' = 'RUST',
+}
+
+export async function getGame(
+  type: GAME_SERVER_TYPE | GameServerOutputDTOTypeEnum,
+  connectionInfo: Record<string, unknown>,
+  settings: Partial<Settings>
+): 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.MOCK:
+      return new Mock(new MockConnectionInfo(connectionInfo), settings);
+    default:
+      throw new errors.NotImplementedError();
+  }
+}

package/src/interfaces/GameServer.ts

@@ -0,0 +1,95 @@
+import { TakaroEmitter } from '../TakaroEmitter.js';
+import { IGamePlayer, IPosition } from '@takaro/modules';
+import { TakaroDTO } from '@takaro/util';
+import { IsBoolean, IsISO8601, IsNumber, 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;
+}
+
+/**
+ * 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;
+}
+
+export class IMessageOptsDTO extends TakaroDTO<IMessageOptsDTO> {
+  @Type(() => IPlayerReferenceDTO)
+  @ValidateNested()
+  /** When specified, will send a DM to this player instead of a global message */
+  recipient?: IPlayerReferenceDTO;
+}
+
+export class BanDTO extends TakaroDTO<BanDTO> {
+  @Type(() => IPlayerReferenceDTO)
+  @ValidateNested()
+  player: IPlayerReferenceDTO;
+
+  @IsString()
+  reason: string;
+
+  @IsISO8601()
+  @IsOptional()
+  expiresAt: string | null;
+}
+
+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): Promise<void>;
+  listItems(): Promise<IItemDTO[]>;
+
+  executeConsoleCommand(rawCommand: string): Promise<CommandOutput>;
+  sendMessage(message: string, opts: IMessageOptsDTO): Promise<void>;
+  teleportPlayer(player: IPlayerReferenceDTO, x: number, y: number, z: number): 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[]>;
+}

package/src/main.ts

@@ -0,0 +1,14 @@
+export * from './interfaces/GameServer.js';
+
+export { TakaroEmitter } from './TakaroEmitter.js';
+
+export { Mock } from './gameservers/mock/index.js';
+export { MockConnectionInfo, mockJsonSchema } from './gameservers/mock/connectionInfo.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';

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.esm.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist"]
+}

package/typedoc.json

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