@takaro/gameserver 0.0.1

package/src/gameservers/7d2d/__tests__/7d2dEventDetection.unit.test.ts

@@ -0,0 +1,324 @@
+/* eslint-disable quotes */
+import { expect, sandbox } from '@takaro/test';
+import {
+  EventChatMessage,
+  EventEntityKilled,
+  EventPlayerConnected,
+  EventPlayerDeath,
+  GameEvents,
+  IGamePlayer,
+} from '@takaro/modules';
+import { SdtdConnectionInfo } from '../connectionInfo.js';
+import { SevenDaysToDieEmitter } from '../emitter.js';
+import { SevenDaysToDie } from '../index.js';
+
+const mockConnectionInfo = async (overrides?: Partial<SdtdConnectionInfo>) =>
+  new SdtdConnectionInfo({
+    adminToken: 'aaa',
+    adminUser: 'aaa',
+    useTls: false,
+    host: 'localhost',
+    ...overrides,
+  });
+
+const mockGamePlayer = new IGamePlayer({
+  name: 'Catalysm',
+  ping: undefined,
+  gameId: '0002b5d970954287afdcb5dc35af0424',
+  steamId: '76561198028175941',
+});
+
+describe('7d2d event detection', () => {
+  let emitStub = sandbox.stub(SevenDaysToDieEmitter.prototype, 'emit');
+
+  beforeEach(() => {
+    sandbox.restore();
+    emitStub = sandbox.stub(SevenDaysToDieEmitter.prototype, 'emit');
+    sandbox.stub(SevenDaysToDie.prototype, 'steamIdOrXboxToGameId').resolves(mockGamePlayer);
+  });
+
+  it('[PlayerConnected]: Can detect simple player connected', async () => {
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo());
+    await emitter.parseMessage({
+      msg: `PlayerSpawnedInWorld (reason: JoinMultiplayer, position: 1873, 66, 347): EntityID=171, PltfmId='Steam_76561198028175941', CrossId='EOS_0002b5d970954287afdcb5dc35af0424', OwnerID='Steam_76561198028175941', PlayerName='Catalysm'`,
+    });
+    expect(emitStub).to.have.been.calledTwice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.PLAYER_CONNECTED);
+    expect((emitStub.getCalls()[0].args[1] as EventPlayerConnected).player).to.deep.equal({
+      name: 'Catalysm',
+      ping: undefined,
+      gameId: '0002b5d970954287afdcb5dc35af0424',
+      steamId: '76561198028175941',
+      epicOnlineServicesId: '0002b5d970954287afdcb5dc35af0424',
+      xboxLiveId: undefined,
+      ip: undefined,
+      platformId: undefined,
+    });
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.LOG_LINE);
+  });
+
+  it('[PlayerConnected]: Can detect simple player connected when player connects for the first time', async () => {
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo());
+    await emitter.parseMessage({
+      msg: `PlayerSpawnedInWorld (reason: EnterMultiplayer, position: 1080, 61, 1089): EntityID=3812, PltfmId='Steam_76561198028175941', CrossId='EOS_0002b5d970954287afdcb5dc35af0424', OwnerID='Steam_76561198028175941', PlayerName='Catalysm', ClientNumber='6'`,
+    });
+    expect(emitStub).to.have.been.calledTwice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.PLAYER_CONNECTED);
+    expect((emitStub.getCalls()[0].args[1] as EventPlayerConnected).player).to.deep.equal({
+      name: 'Catalysm',
+      ping: undefined,
+      gameId: '0002b5d970954287afdcb5dc35af0424',
+      steamId: '76561198028175941',
+      epicOnlineServicesId: '0002b5d970954287afdcb5dc35af0424',
+      xboxLiveId: undefined,
+      ip: undefined,
+      platformId: undefined,
+    });
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.LOG_LINE);
+  });
+
+  it('[PlayerConnected]: Can detect Xbox player connected', async () => {
+    await new SevenDaysToDieEmitter(await mockConnectionInfo()).parseMessage({
+      msg: `PlayerSpawnedInWorld (reason: JoinMultiplayer, position: 1873, 66, 347): EntityID=171, PltfmId='XBL_123456abcdef', CrossId='EOS_0002b5d970954287afdcb5dc35af0424', OwnerID='Steam_76561198028175941', PlayerName='Catalysm'`,
+    });
+    expect(emitStub).to.have.been.calledTwice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.PLAYER_CONNECTED);
+    expect((emitStub.getCalls()[0].args[1] as EventPlayerConnected).player).to.deep.equal({
+      name: 'Catalysm',
+      ping: undefined,
+      gameId: '0002b5d970954287afdcb5dc35af0424',
+      steamId: undefined,
+      xboxLiveId: '123456abcdef',
+      epicOnlineServicesId: '0002b5d970954287afdcb5dc35af0424',
+      ip: undefined,
+      platformId: undefined,
+    });
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.LOG_LINE);
+  });
+
+  it('[PlayerConnected]: Can detect player connected with space', async () => {
+    await new SevenDaysToDieEmitter(await mockConnectionInfo()).parseMessage({
+      msg: `PlayerSpawnedInWorld (reason: JoinMultiplayer, position: 1873, 66, 347): EntityID=171, PltfmId='Steam_76561198028175941', CrossId='EOS_0002b5d970954287afdcb5dc35af0424', OwnerID='Steam_76561198028175941', PlayerName='Cata lysm'`,
+    });
+    expect(emitStub).to.have.been.calledTwice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.PLAYER_CONNECTED);
+    expect((emitStub.getCalls()[0].args[1] as EventPlayerConnected).player).to.deep.equal({
+      name: 'Cata lysm',
+      ping: undefined,
+      gameId: '0002b5d970954287afdcb5dc35af0424',
+      steamId: '76561198028175941',
+      epicOnlineServicesId: '0002b5d970954287afdcb5dc35af0424',
+      xboxLiveId: undefined,
+      ip: undefined,
+      platformId: undefined,
+    });
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.LOG_LINE);
+  });
+
+  it('[PlayerDisconnected]: Can detect simple player disconnected', async () => {
+    await new SevenDaysToDieEmitter(await mockConnectionInfo()).parseMessage({
+      // eslint-disable-next-line quotes
+      msg: `Player disconnected: EntityID=171, PltfmId='Steam_76561198028175941', CrossId='EOS_0002b5d970954287afdcb5dc35af0424', OwnerID='Steam_76561198028175941', PlayerName='Catalysm'`,
+    });
+    expect(emitStub).to.have.been.calledTwice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.PLAYER_DISCONNECTED);
+    expect((emitStub.getCalls()[0].args[1] as EventPlayerConnected).player).to.deep.equal({
+      name: 'Catalysm',
+      ping: undefined,
+      gameId: '0002b5d970954287afdcb5dc35af0424',
+      steamId: '76561198028175941',
+      xboxLiveId: undefined,
+      ip: undefined,
+      platformId: undefined,
+      epicOnlineServicesId: undefined,
+    });
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.LOG_LINE);
+  });
+
+  it('[ChatMessage] Can detect chat message', async () => {
+    // Chat handled by mod 'CSMM Patrons': Chat (from 'Steam_76561198028175941', entity id '549', to 'Global'): 'Catalysm': /ping
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo());
+
+    await emitter.parseMessage({
+      // eslint-disable-next-line quotes
+      msg: `Chat handled by mod 'CSMM Patrons': Chat (from 'Steam_76561198028175941', entity id '549', to 'Global'): 'Catalysm': fsafsafasf`,
+    });
+
+    expect(emitStub).to.have.been.calledTwice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.CHAT_MESSAGE);
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.LOG_LINE);
+
+    expect((emitStub.getCalls()[0].args[1] as EventChatMessage).player).to.deep.equal({
+      name: 'Catalysm',
+      ping: undefined,
+      gameId: '0002b5d970954287afdcb5dc35af0424',
+      steamId: '76561198028175941',
+      xboxLiveId: undefined,
+      ip: undefined,
+      platformId: undefined,
+      epicOnlineServicesId: undefined,
+    });
+  });
+
+  it('[ChatMessage] Can deduplicate messages when a mod handles it', async () => {
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo());
+
+    await emitter.parseMessage({
+      // eslint-disable-next-line quotes
+      msg: `"Chat (from '-non-player-', entity id '-1', to 'Global'): 'Cata': a"`,
+    });
+
+    await emitter.parseMessage({
+      // eslint-disable-next-line quotes
+      msg: `Chat handled by mod '1CSMM_Patrons': Chat (from 'Steam_76561198028175941', entity id '546', to 'Global'): 'Catalysm': &ping`,
+    });
+
+    expect(emitStub).to.have.been.calledThrice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.LOG_LINE);
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.CHAT_MESSAGE);
+    expect(emitStub.getCalls()[2].args[0]).to.equal(GameEvents.LOG_LINE);
+
+    expect((emitStub.getCalls()[1].args[1] as EventChatMessage).player).to.deep.equal({
+      name: 'Catalysm',
+      ping: undefined,
+      gameId: '0002b5d970954287afdcb5dc35af0424',
+      steamId: '76561198028175941',
+      xboxLiveId: undefined,
+      ip: undefined,
+      platformId: undefined,
+      epicOnlineServicesId: undefined,
+    });
+  });
+
+  it('[ChatMessage] Can deduplicate messages when a mod handles it (bulk test)', async () => {
+    const messages = ['Hello', 'Testing', 'If the', 'chat is', 'working'];
+
+    const logsToSend = messages
+      .map((message) => {
+        return [
+          {
+            msg: `Chat handled by mod 'ServerTools': Chat (from 'Steam_76561198028175941', entity id '2196446', to 'Global'): 'Catalysm': ${message}`,
+          },
+          {
+            msg: `Chat (from 'Steam_76561198028175941', entity id '-1', to 'Global'): 'Catalysm': ${message}`,
+          },
+        ];
+      })
+      .flat();
+
+    const logsToSendRandomized = logsToSend.sort(() => Math.random() - 0.5);
+
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo());
+
+    await Promise.all(logsToSendRandomized.map(emitter.parseMessage));
+
+    expect(emitStub).to.have.callCount(messages.length * 3);
+
+    for (const msg of messages) {
+      expect(
+        emitStub.getCalls().some((call) => {
+          return call.args[0] === GameEvents.CHAT_MESSAGE && (call.args[1] as EventChatMessage).msg === msg;
+        })
+      ).to.equal(true);
+    }
+  });
+
+  it('[PlayerDeath] Can detect player death', async () => {
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo());
+
+    await emitter.parseMessage({
+      msg: `GMSG: Player '${mockGamePlayer.name}' died`,
+    });
+    await emitter.parseMessage({
+      msg: `[CSMM_Patrons]playerDied: ${mockGamePlayer.name} (Steam_${mockGamePlayer.steamId}) died @ 702 34 -2938`,
+    });
+
+    expect(emitStub).to.have.been.calledThrice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.PLAYER_DEATH);
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.LOG_LINE);
+    expect(emitStub.getCalls()[2].args[0]).to.equal(GameEvents.LOG_LINE);
+
+    expect((emitStub.getCalls()[0].args[1] as EventPlayerDeath).player.name).to.equal(mockGamePlayer.name);
+
+    expect((emitStub.getCalls()[0].args[1] as EventPlayerDeath).position).to.deep.equal({
+      x: NaN,
+      y: NaN,
+      z: NaN,
+    });
+  });
+
+  it('[PlayerDeath] Can detect CPM player death', async () => {
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo({ useCPM: true }));
+
+    await emitter.parseMessage({
+      msg: `GMSG: Player '${mockGamePlayer.name}' died`,
+    });
+    await emitter.parseMessage({
+      msg: `[CSMM_Patrons]playerDied: ${mockGamePlayer.name} (Steam_${mockGamePlayer.steamId}) died @ 702 34 -2938`,
+    });
+
+    expect(emitStub).to.have.been.calledThrice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.LOG_LINE);
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.PLAYER_DEATH);
+    expect(emitStub.getCalls()[2].args[0]).to.equal(GameEvents.LOG_LINE);
+
+    expect((emitStub.getCalls()[1].args[1] as EventPlayerDeath).player.name).to.equal(mockGamePlayer.name);
+
+    expect((emitStub.getCalls()[1].args[1] as EventPlayerDeath).position).to.deep.equal({
+      x: 702,
+      y: 34,
+      z: -2938,
+    });
+  });
+
+  it('[EntityKilled] Can detect entity killed', async () => {
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo());
+
+    await emitter.parseMessage({
+      msg: `Entity zombieNurse 613814 killed by ${mockGamePlayer.name} 54854`,
+    });
+    await emitter.parseMessage({
+      msg: `[CSMM_Patrons]entityKilled: ${mockGamePlayer.name} (Steam_${mockGamePlayer.steamId}) killed zombie zombieNurse with S.H.I.E.L.D. Auto Shotgun`,
+    });
+
+    expect(emitStub).to.have.been.calledThrice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.ENTITY_KILLED);
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.LOG_LINE);
+    expect(emitStub.getCalls()[2].args[0]).to.equal(GameEvents.LOG_LINE);
+
+    expect((emitStub.getCalls()[0].args[1] as EventEntityKilled).entity).to.equal('zombieNurse');
+    expect((emitStub.getCalls()[0].args[1] as EventEntityKilled).player.name).to.equal(mockGamePlayer.name);
+    expect((emitStub.getCalls()[0].args[1] as EventEntityKilled).weapon).to.equal(undefined);
+  });
+
+  it('[EntityKilled] Can detect CPM entity killed', async () => {
+    const emitter = new SevenDaysToDieEmitter(await mockConnectionInfo({ useCPM: true }));
+
+    await emitter.parseMessage({
+      msg: `Entity zombieNurse 613814 killed by ${mockGamePlayer.name} 54854`,
+    });
+    await emitter.parseMessage({
+      msg: `[CSMM_Patrons]entityKilled: ${mockGamePlayer.name} (Steam_${mockGamePlayer.steamId}) killed zombie zombieNurse with S.H.I.E.L.D. Auto Shotgun`,
+    });
+
+    expect(emitStub).to.have.been.calledThrice;
+
+    expect(emitStub.getCalls()[0].args[0]).to.equal(GameEvents.LOG_LINE);
+    expect(emitStub.getCalls()[1].args[0]).to.equal(GameEvents.ENTITY_KILLED);
+    expect(emitStub.getCalls()[2].args[0]).to.equal(GameEvents.LOG_LINE);
+
+    expect((emitStub.getCalls()[1].args[1] as EventEntityKilled).entity).to.equal('zombieNurse');
+    expect((emitStub.getCalls()[1].args[1] as EventEntityKilled).player.name).to.equal(mockGamePlayer.name);
+    expect((emitStub.getCalls()[1].args[1] as EventEntityKilled).weapon).to.equal('S.H.I.E.L.D. Auto Shotgun');
+  });
+});

package/src/gameservers/7d2d/apiResponses.ts

@@ -0,0 +1,214 @@
+export interface GameTime {
+  days: number;
+  hours: number;
+  minutes: number;
+}
+
+export interface StatsResponse {
+  gametime: GameTime;
+  players: number;
+  hostiles: number;
+  animals: number;
+}
+
+export interface Position {
+  x: number;
+  y: number;
+  z: number;
+}
+
+export interface OnlinePlayerResponse {
+  steamid: string;
+  crossplatformid: string;
+  entityid: number;
+  ip: string;
+  name: string;
+  online: boolean;
+  position: Position;
+  level: number;
+  health: number;
+  stamina: number;
+  zombiekills: number;
+  playerkills: number;
+  playerdeaths: number;
+  score: number;
+  totalplaytime: number;
+  lastonline: string;
+  ping: number;
+}
+
+export interface EntityLocation {
+  id: number;
+  name: string;
+  position: Position;
+}
+
+export interface LandClaimsResponse {
+  claimsize: number;
+  claimowners: Array<ClaimOwner>;
+}
+
+export interface ClaimOwner {
+  steamid: string;
+  claimactive: boolean;
+  playername: string;
+  claims: Array<Position>;
+}
+
+export interface CommandResponse {
+  command: string;
+  parameters: string;
+  result: string;
+}
+
+export interface AllowedCommands {
+  commands: Array<CommandEntry>;
+}
+
+export interface CommandEntry {
+  command: string;
+  description: string;
+  help: string;
+}
+
+export interface InventoryResponse {
+  playername: string;
+  userid: string;
+  crossplatformid: string;
+  bag: Array<InventoryItem>;
+  belt: Array<InventoryItem>;
+  equipment: PlayerEquipment;
+}
+
+export interface InventoryItem {
+  count: number;
+  name: string;
+  icon: string;
+  iconcolor: string;
+  quality: number;
+}
+
+export interface PlayerEquipment extends Record<string, InventoryItem> {
+  head: InventoryItem;
+  eyes: InventoryItem;
+  face: InventoryItem;
+  armor: InventoryItem;
+  jacket: InventoryItem;
+  shirt: InventoryItem;
+  legarmor: InventoryItem;
+  pants: InventoryItem;
+  boots: InventoryItem;
+  gloves: InventoryItem;
+}
+/* eslint-enable */
+
+export interface PlayerListResponse {
+  total: number;
+  totalUnfiltered: number;
+  firstResult: number;
+  players: Array<PlayerNotOnline>;
+}
+
+export interface PlayerNotOnline {
+  steamid: string;
+  entityid: number;
+  ip: string;
+  name: string;
+  online: boolean;
+  position: Position;
+  totalplaytime: number;
+  lastonline: string;
+  ping: number;
+  banned: boolean;
+}
+
+export interface PlayerLocation {
+  steamid: string;
+  crossplatformid: string;
+  name: string;
+  online: boolean;
+  position: Position;
+}
+
+export interface GetServerInfo {
+  GameType: GetServerInfoEntry;
+  GameName: GetServerInfoEntry;
+  GameHost: GetServerInfoEntry;
+  ServerDescription: GetServerInfoEntry;
+  ServerWebsiteURL: GetServerInfoEntry;
+  LevelName: GetServerInfoEntry;
+  GameMode: GetServerInfoEntry;
+  Version: GetServerInfoEntry;
+  IP: GetServerInfoEntry;
+  CountryCode: GetServerInfoEntry;
+  SteamID: GetServerInfoEntry;
+  CompatibilityVersion: GetServerInfoEntry;
+  Platform: GetServerInfoEntry;
+  Port: GetServerInfoEntry;
+  CurrentPlayers: GetServerInfoEntry;
+  MaxPlayers: GetServerInfoEntry;
+  GameDifficulty: GetServerInfoEntry;
+  DayNightLength: GetServerInfoEntry;
+  ZombiesRun: GetServerInfoEntry;
+  DayCount: GetServerInfoEntry;
+  Ping: GetServerInfoEntry;
+  DropOnDeath: GetServerInfoEntry;
+  DropOnQuit: GetServerInfoEntry;
+  BloodMoonEnemyCount: GetServerInfoEntry;
+  EnemyDifficulty: GetServerInfoEntry;
+  PlayerKillingMode: GetServerInfoEntry;
+  CurrentServerTime: GetServerInfoEntry;
+  DayLightLength: GetServerInfoEntry;
+  BlockDurabilityModifier: GetServerInfoEntry;
+  AirDropFrequency: GetServerInfoEntry;
+  LootAbundance: GetServerInfoEntry;
+  LootRespawnDays: GetServerInfoEntry;
+  MaxSpawnedZombies: GetServerInfoEntry;
+  LandClaimSize: GetServerInfoEntry;
+  LandClaimDeadZone: GetServerInfoEntry;
+  LandClaimExpiryTime: GetServerInfoEntry;
+  LandClaimDecayMode: GetServerInfoEntry;
+  LandClaimOnlineDurabilityModifier: GetServerInfoEntry;
+  LandClaimOfflineDurabilityModifier: GetServerInfoEntry;
+  MaxSpawnedAnimals: GetServerInfoEntry;
+  IsDedicated: GetServerInfoEntry;
+  IsPasswordProtected: GetServerInfoEntry;
+  ShowFriendPlayerOnMap: GetServerInfoEntry;
+  BuildCreate: GetServerInfoEntry;
+  EACEnabled: GetServerInfoEntry;
+  Architecture64: GetServerInfoEntry;
+  StockSettings: GetServerInfoEntry;
+  StockFiles: GetServerInfoEntry;
+  RequiresMod: GetServerInfoEntry;
+  AirDropMarker: GetServerInfoEntry;
+  EnemySpawnMode: GetServerInfoEntry;
+  IsPublic: GetServerInfoEntry;
+}
+
+export interface GetServerInfoEntry {
+  type: string;
+  value: any; // eslint-disable-line
+}
+
+export interface GetWebUIUpdatesResponse {
+  gametime: GameTime;
+  players: number;
+  hostiles: number;
+  animals: number;
+  newlogs: number;
+}
+
+export interface LogLine {
+  date: string;
+  time: string;
+  uptime: string;
+  msg: string;
+  trace: string;
+  type: string;
+}
+
+export interface GetLog {
+  firstLine: number;
+  lastLine: number;
+  entries: Array<LogLine>;
+}

package/src/gameservers/7d2d/connectionInfo.ts

@@ -0,0 +1,40 @@
+import { IsString, IsBoolean } from 'class-validator';
+import { TakaroDTO } from '@takaro/util';
+
+export class SdtdConnectionInfo extends TakaroDTO<SdtdConnectionInfo> {
+  @IsString()
+  public readonly host!: string;
+  @IsString()
+  public readonly adminUser!: string;
+  @IsString()
+  public readonly adminToken!: string;
+  @IsBoolean()
+  public readonly useTls!: boolean;
+  @IsBoolean()
+  public readonly useCPM!: boolean;
+}
+
+export const sdtdJsonSchema = {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'SdtdConnectionInfo',
+  type: 'object',
+  properties: {
+    host: {
+      type: 'string',
+    },
+    adminUser: {
+      type: 'string',
+    },
+    adminToken: {
+      type: 'string',
+    },
+    useTls: {
+      type: 'boolean',
+    },
+    useCPM: {
+      type: 'boolean',
+      default: false,
+    },
+  },
+  required: ['host', 'adminUser', 'adminToken', 'useTls'],
+};