feat: add CreateNewGame

Author: Shinigami92

src/index.ts

@@ -13,6 +13,8 @@ export type {
   ClaimServerRequest,
   ClaimServerResponse,
   ClaimServerResponseData,
+  CreateNewGameRequest,
+  CreateNewGameResponse,
   ErrorResponse,
   GetAdvancedGameSettingsRequest,
   GetAdvancedGameSettingsResponse,

src/v1/CreateNewGame.ts

@@ -0,0 +1,68 @@
+import type { ApiRequest, BooleanString } from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export type CreateNewGameRequest = ApiRequest<
+  "CreateNewGame",
+  {
+    /**
+     * Parameters needed to create new game session.
+     */
+    newGameData: {
+      /**
+       * Name of the session to create.
+       */
+      sessionName: string;
+      /**
+       * Path Name to the Map Package to use as a map.
+       *
+       * If not specified, default level.
+       */
+      mapName?: string;
+      /**
+       * Name of the starting location to use.
+       *
+       * Leaving it empty will use random starting location.
+       */
+      startingLocation: string;
+      /**
+       * Whenever the Onboarding should be skipped.
+       *
+       * Currently Onboarding is always skipped on the Dedicated Servers.
+       */
+      skipOnboarding: boolean;
+      /**
+       * Advanced Game Settings to apply to the newly created session.
+       */
+      advancedGameSettings: {
+        "FG.GameRules.NoPower"?: BooleanString;
+        "FG.GameRules.DisableArachnidCreatures"?: BooleanString;
+        "FG.GameRules.NoUnlockCost"?: BooleanString;
+        "FG.GameRules.SetGamePhase"?: string;
+        "FG.GameRules.GiveAllTiers"?: BooleanString;
+        "FG.GameRules.UnlockAllResearchSchematics"?: BooleanString;
+        "FG.GameRules.UnlockInstantAltRecipes"?: BooleanString;
+        "FG.GameRules.UnlockAllResourceSinkSchematics"?: BooleanString;
+        "FG.GameRules.GiveItems"?: string;
+        "FG.PlayerRules.NoBuildCost"?: BooleanString;
+        "FG.PlayerRules.GodMode"?: BooleanString;
+        "FG.PlayerRules.FlightMode"?: BooleanString;
+        [key: string]: string | BooleanString | undefined;
+      };
+      /**
+       * Custom Options to pass to the newly created session URL.
+       *
+       * Not used by vanilla Dedicated Servers.
+       */
+      customOptionsOnlyForModding: Record<string, string>;
+    };
+  }
+>;
+
+export type CreateNewGameResponse = string;
+
+export const buildCreateNewGame = buildApiRequest<
+  CreateNewGameRequest,
+  CreateNewGameResponse
+>("v1", {
+  function: "CreateNewGame",
+});

src/v1/index.ts

@@ -2,6 +2,7 @@ import { buildApplyAdvancedGameSettings } from "./ApplyAdvancedGameSettings.js";
 import { buildApplyServerOptions } from "./ApplyServerOptions.js";
 import { buildClaimServer } from "./ClaimServer.js";
 import type { InternalClientOptions } from "./common.js";
+import { buildCreateNewGame } from "./CreateNewGame.js";
 import { buildGetAdvancedGameSettings } from "./GetAdvancedGameSettings.js";
 import { buildGetServerOptions } from "./GetServerOptions.js";
 import { buildHealthCheck } from "./HealthCheck.js";
@@ -138,13 +139,22 @@ export function buildV1(options: InternalClientOptions) {
      * Function does not return any data on success.
      */
     ApplyServerOptions: buildApplyServerOptions(options),
+    /**
+     * Creates a new session on the Dedicated Server, and immediately loads it.
+     *
+     * HTTPS API becomes temporarily unavailable when map loading is in progress.
+     *
+     * Function does not return any data on success.
+     */
+    CreateNewGame: buildCreateNewGame(options),
   };
 }
 
 export type * from "./ApplyAdvancedGameSettings.js";
 export type * from "./ApplyServerOptions.js";
 export type * from "./ClaimServer.js";
 export type * from "./common.js";
+export type * from "./CreateNewGame.js";
 export type * from "./error.js";
 export type * from "./GetAdvancedGameSettings.js";
 export type * from "./GetServerOptions.js";