@oasisomniverse/web5-api 1.0.0

package/docs/modules/Games.md

@@ -0,0 +1,2619 @@
+# Games — `star.games`
+
+Source controller: [`GamesController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/GamesController.cs)
+Route prefix: `api/games`
+55 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `activateGame`
+
+Activates a game.
+
+**POST** `api/games/{id}/activate`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.activateGame({
+    id: '<id>',
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `addItemToInventory`
+
+Adds an item to the avatar's shared inventory (can be used across all games, apps, websites, services)
+
+**POST** `api/games/shared-inventory/add`
+
+**Request**
+
+Body type: `InventoryItem`
+
+| Field | Type |
+| --- | --- |
+| `Image2D` | `byte[]` |
+| `Image2DURI` | `Uri` |
+| `ThumbnailUrl` | `string` |
+| `Object3D` | `byte[]` |
+| `Object3DURI` | `Uri` |
+| `Quantity` | `int` |
+| `Stack` | `bool` |
+| `GameSource` | `string` |
+| `ItemType` | `string` |
+| `NftId` | `string` |
+| `InventoryItemType` | `InventoryItemType` |
+| `Rarity` | `string` |
+| `MaxQuantity` | `int` |
+| `Weight` | `float` |
+| `IsUsable` | `bool` |
+| `IsTradeable` | `bool` |
+| `OwnerAvatarId` | `string` |
+| `AcquiredOn` | `DateTime` |
+| `LastUsedOn` | `DateTime` |
+| `Properties` | `Dictionary<string, object>` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.addItemToInventory({
+    image2D: "<base64-bytes>",
+    image2DURI: "https://example.com/asset.png",
+    thumbnailUrl: "example string",
+    object3D: "<base64-bytes>",
+    object3DURI: "https://example.com/asset.png",
+    quantity: 1,
+    stack: true,
+    gameSource: "example string",
+    itemType: "example string",
+    nftId: "example string",
+    inventoryItemType: {  },
+    rarity: "example string",
+    maxQuantity: 1,
+    weight: 1.0,
+    isUsable: true,
+    isTradeable: true,
+    ownerAvatarId: "example string",
+    acquiredOn: "2026-01-01T00:00:00Z",
+    lastUsedOn: "2026-01-01T00:00:00Z",
+    properties: { "<string>": {} }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `bindKeys`
+
+Binds keys to actions
+
+**POST** `api/games/{gameId}/input/bind-keys`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+Body type: `Dictionary<string, string>` - a key/value map keyed by `string`, each value a `string`.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.bindKeys({
+    gameId: '<gameId>',
+    /* ...request body fields */
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `cloneGame`
+
+Clones an existing game.
+
+**POST** `api/games/{id}/clone`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `CloneRequest`
+
+| Field | Type |
+| --- | --- |
+| `NewName` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.cloneGame({
+    id: '<id>',
+    newName: "example string"
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `createGame`
+
+Creates a new game for the authenticated avatar.
+
+**POST** `api/games`
+
+**Request**
+
+Body type: `IGame`
+
+| Field | Type |
+| --- | --- |
+| `GameType` | `GameType` |
+| `Version` | `string` |
+| `Developer` | `string` |
+| `Publisher` | `string` |
+| `ReleaseDate` | `DateTime` |
+| `SupportedPlatforms` | `List<string>` |
+| `SupportsCrossGameInterop` | `bool` |
+| `GameSettings` | `Dictionary<string, object>` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.createGame({
+    gameType: {  },
+    version: "example string",
+    developer: "example string",
+    publisher: "example string",
+    releaseDate: "2026-01-01T00:00:00Z",
+    supportedPlatforms: ["example string"],
+    supportsCrossGameInterop: true,
+    gameSettings: { "<string>": {} }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `createGameWithOptions`
+
+Creates a new game with specified parameters.
+
+**POST** `api/games/create`
+
+**Request**
+
+Body type: `CreateGameRequest`
+
+| Field | Type |
+| --- | --- |
+| `Name` | `string` |
+| `Description` | `string` |
+| `HolonSubType` | `HolonType` |
+| `SourceFolderPath` | `string` |
+| `CreateOptions` | `ISTARNETCreateOptions<Game, STARNETDNA>` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.createGameWithOptions({
+    name: "example string",
+    description: "example string",
+    holonSubType: {  },
+    sourceFolderPath: "example string",
+    createOptions: { "STARNETHolon": /* <T1> */, "STARNETDNA": /* <T2> */, "MetaTagMappings": { "MetaHolonTags": [{ "HolonName": "example string", "HolonType": {  }, "NodeName": "example string", "NodeType": { "Score": 1.0 }, "MetaTag": "example string" }], "MetaTags": { "<string>": "example string" } }, "CheckIfSourcePathExists": true, "CustomCreateParams": { "<string>": {} } }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `deactivateGame`
+
+Deactivates a game.
+
+**POST** `api/games/{id}/deactivate`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.deactivateGame({
+    id: '<id>',
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `deleteGame`
+
+Deletes a game.
+
+**DELETE** `api/games/{id}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.deleteGame({
+    id: '<id>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `downloadGame`
+
+Downloads a game from the STARNET system.
+
+**POST** `api/games/{id}/download`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+| `downloadPath` | `string (optional)` |
+| `reInstall` | `bool (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.downloadGame({
+    id: '<id>',
+    version: 1,
+    downloadPath: 'example string',
+    reInstall: true
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `editGame`
+
+Edits a game with new DNA configuration.
+
+**POST** `api/games/{id}/edit`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `EditGameRequest`
+
+| Field | Type |
+| --- | --- |
+| `NewDNA` | `STARNETDNA` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.editGame({
+    id: '<id>',
+    newDNA: { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "example string", "Description": "example string", "STARNETHolonType": "example string", "STARNETCategory": {}, "STARNETSubCategory": {}, "Dependencies": { "OAPPs": [{ "Type": {  }, "HolonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "STARNETHolonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "example string", "Description": "example string", "Version": "example string", "VersionSequence": 1, "Install": true, "InstallMode": {  }, "InstalledFrom": "example string", "InstalledTo": "example string" }], "Runtimes": [], "Libraries": [], "Templates": [], "NFTs": [], "NFTCollections": [], "GeoNFTs": [], "GeoNFTCollections": [], "GeoHotSpots": [], "Quests": [], "Missions": [], "Chapters": [], "InventoryItems": [], "CelestialSpaces": [], "CelestialBodies": [], "Zomes": [], "Holons": [], "CelestialBodiesMetaDataDNA": [], "ZomesMetaDataDNA": [], "HolonsMetaDataDNA": [] }, "MetaData": { "<string>": {} }, "MetaHolonTagMappings": /* <>> */, "MetaTagMappings": { "<string>": "example string" }, "CreatedByAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "CreatedByAvatarUsername": "example string", "CreatedOn": "2026-01-01T00:00:00Z", "SourcePath": "example string", "PublishedPath": "example string", "PublishedByAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "PublishedByAvatarUsername": "example string", "PublishedOn": "2026-01-01T00:00:00Z", "LaunchTarget": "example string", "ModifiedByAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ModifiedByAvatarUsername": "example string", "ModifiedOn": "2026-01-01T00:00:00Z", "PublishedOnSTARNET": true, "PublishedToCloud": true, "PublishedToPinata": true, "PinataIPFSHash": "example string", "PublishedProviderType": "example string", "FileSize": 1, "Version": "example string", "OASISRuntimeVersion": "example string", "OASISAPIVersion": "example string", "COSMICVersion": "example string", "STARRuntimeVersion": "example string", "STARODKVersion": "example string", "STARAPIVersion": "example string", "STARNETVersion": "example string", "DotNetVersion": "example string", "VersionSequence": 1, "Downloads": 1, "Installs": 1, "TotalDownloads": 1, "TotalInstalls": 1, "NumberOfVersions": 1 }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `endGame`
+
+Ends a game session
+
+**POST** `api/games/{gameId}/end`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.endGame({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getAllGames`
+
+Retrieves all games in the system.
+
+**GET** `api/games`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getAllGames({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getAvatarKarma`
+
+Gets avatar's karma score (shared across all games)
+
+**GET** `api/games/karma`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getAvatarKarma({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getCrossGameQuests`
+
+Gets active quests that span multiple games
+
+**GET** `api/games/cross-game-quests`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getCrossGameQuests({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getGame`
+
+Retrieves a specific game by its unique identifier.
+
+**GET** `api/games/{id}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getGame({
+    id: '<id>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getGameVersions`
+
+Gets all versions of a specific game.
+
+**GET** `api/games/{id}/versions`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getGameVersions({
+    id: '<id>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getGamesByType`
+
+Gets games by type.
+
+**GET** `api/games/by-type/{type}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `type` | `string` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getGamesByType({
+    type: '<type>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getKeyBindings`
+
+Gets current key bindings
+
+**GET** `api/games/{gameId}/input/bind-keys`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getKeyBindings({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getMasterVolume`
+
+Gets the master volume
+
+**GET** `api/games/{gameId}/audio/master-volume`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getMasterVolume({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getSharedInventory`
+
+Gets shared inventory items (keycards, items, etc.) that can be used across games, apps, websites, services This uses the AvatarDetail.Inventory property - the avatar's actual owned inventory
+
+**GET** `api/games/shared-inventory`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getSharedInventory({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getSoundVolume`
+
+Gets the sound volume
+
+**GET** `api/games/{gameId}/audio/sound-volume`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getSoundVolume({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getVideoSetting`
+
+Gets the video quality setting
+
+**GET** `api/games/{gameId}/video/setting`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getVideoSetting({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getVoiceVolume`
+
+Gets the voice volume
+
+**GET** `api/games/{gameId}/audio/voice-volume`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.getVoiceVolume({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `hasItem`
+
+Checks if the avatar has a specific item in their shared inventory
+
+**GET** `api/games/shared-inventory/{itemId}/has`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `itemId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.hasItem({
+    itemId: '<itemId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `hasItemByName`
+
+Checks if the avatar has a specific item by name in their shared inventory
+
+**GET** `api/games/shared-inventory/has-by-name`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `itemName` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.hasItemByName({
+    itemName: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `installGame`
+
+Installs a downloaded game.
+
+**POST** `api/games/{id}/install`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+| `installPath` | `string (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.installGame({
+    id: '<id>',
+    version: 1,
+    installPath: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `jumpToArea`
+
+Jumps to a specific area
+
+**POST** `api/games/{gameId}/areas/jump`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+Body type: `JumpToAreaRequest`
+
+| Field | Type |
+| --- | --- |
+| `X` | `double` |
+| `Y` | `double` |
+| `Z` | `double` |
+| `Radius` | `double` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.jumpToArea({
+    gameId: '<gameId>',
+    x: 1.0,
+    y: 1.0,
+    z: 1.0,
+    radius: 1.0
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `jumpToLevel`
+
+Jumps to a specific level
+
+**POST** `api/games/{gameId}/levels/{level}/jump`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+| `level` | `string` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.jumpToLevel({
+    gameId: '<gameId>',
+    level: '<level>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `jumpToPointInLevel`
+
+Jumps to a specific point in a level
+
+**POST** `api/games/{gameId}/levels/{level}/jump-to-point`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+| `level` | `string` |
+
+**Request**
+
+Body type: `Point3D`
+
+| Field | Type |
+| --- | --- |
+| `X` | `double` |
+| `Y` | `double` |
+| `Z` | `double` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.jumpToPointInLevel({
+    gameId: '<gameId>',
+    level: '<level>',
+    x: 1.0,
+    y: 1.0,
+    z: 1.0
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadAllGamesForAvatar`
+
+Loads all games for the authenticated avatar.
+
+**GET** `api/games/load-all-for-avatar`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `showAllVersions` | `bool (optional)` |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.loadAllGamesForAvatar({
+    showAllVersions: true,
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadArea`
+
+Loads an area around a specific point
+
+**POST** `api/games/{gameId}/areas/load`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+Body type: `LoadAreaRequest`
+
+| Field | Type |
+| --- | --- |
+| `X` | `double` |
+| `Y` | `double` |
+| `Z` | `double` |
+| `Radius` | `double` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.loadArea({
+    gameId: '<gameId>',
+    x: 1.0,
+    y: 1.0,
+    z: 1.0,
+    radius: 1.0
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadGame`
+
+Loads a game into memory
+
+**POST** `api/games/{gameId}/load`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.loadGame({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadGameById`
+
+Loads a game by ID with optional version and holon type.
+
+**GET** `api/games/{id}/load`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+| `holonType` | `string (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.loadGameById({
+    id: '<id>',
+    version: 1,
+    holonType: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadGameFromPath`
+
+Loads a game from source or installed folder path.
+
+**GET** `api/games/load-from-path`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `path` | `string` |
+| `holonType` | `string (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.loadGameFromPath({
+    path: 'example string',
+    holonType: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadGameFromPublished`
+
+Loads a game from a published file.
+
+**GET** `api/games/load-from-published`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `publishedFilePath` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.loadGameFromPublished({
+    publishedFilePath: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadGameVersion`
+
+Loads a specific version of a game.
+
+**GET** `api/games/{id}/version/{version}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+| `version` | `string` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.loadGameVersion({
+    id: '<id>',
+    version: '<version>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadLevel`
+
+Loads a specific level in a game
+
+**POST** `api/games/{gameId}/levels/{level}/load`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+| `level` | `string` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.loadLevel({
+    gameId: '<gameId>',
+    level: '<level>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `publishGame`
+
+Publishes a game to the STARNET system.
+
+**POST** `api/games/{id}/publish`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `PublishRequest`
+
+| Field | Type |
+| --- | --- |
+| `SourcePath` | `string` |
+| `LaunchTarget` | `string` |
+| `PublishPath` | `string` |
+| `Edit` | `bool` |
+| `RegisterOnSTARNET` | `bool` |
+| `GenerateBinary` | `bool` |
+| `UploadToCloud` | `bool` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.publishGame({
+    id: '<id>',
+    sourcePath: "example string",
+    launchTarget: "example string",
+    publishPath: "example string",
+    edit: true,
+    registerOnSTARNET: true,
+    generateBinary: true,
+    uploadToCloud: true
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `removeItemFromInventory`
+
+Removes an item from the avatar's shared inventory
+
+**DELETE** `api/games/shared-inventory/{itemId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `itemId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.removeItemFromInventory({
+    itemId: '<itemId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `republishGame`
+
+Republishes a game to the STARNET system.
+
+**POST** `api/games/{id}/republish`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `PublishRequest`
+
+| Field | Type |
+| --- | --- |
+| `SourcePath` | `string` |
+| `LaunchTarget` | `string` |
+| `PublishPath` | `string` |
+| `Edit` | `bool` |
+| `RegisterOnSTARNET` | `bool` |
+| `GenerateBinary` | `bool` |
+| `UploadToCloud` | `bool` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.republishGame({
+    id: '<id>',
+    sourcePath: "example string",
+    launchTarget: "example string",
+    publishPath: "example string",
+    edit: true,
+    registerOnSTARNET: true,
+    generateBinary: true,
+    uploadToCloud: true
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `searchGames`
+
+Searches games by name or description.
+
+**GET** `api/games/search`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `query` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.searchGames({
+    query: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `setMasterVolume`
+
+Sets the master volume
+
+**POST** `api/games/{gameId}/audio/master-volume`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+Body type: `VolumeRequest`
+
+| Field | Type |
+| --- | --- |
+| `Volume` | `double` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.setMasterVolume({
+    gameId: '<gameId>',
+    volume: 1.0
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `setSoundVolume`
+
+Sets the sound volume
+
+**POST** `api/games/{gameId}/audio/sound-volume`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+Body type: `VolumeRequest`
+
+| Field | Type |
+| --- | --- |
+| `Volume` | `double` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.setSoundVolume({
+    gameId: '<gameId>',
+    volume: 1.0
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `setVideoSetting`
+
+Sets the video quality setting
+
+**POST** `api/games/{gameId}/video/setting`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+Body type: `VideoSettingRequest`
+
+| Field | Type |
+| --- | --- |
+| `Setting` | `VideoSetting` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.setVideoSetting({
+    gameId: '<gameId>',
+    setting: {  }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `setVoiceVolume`
+
+Sets the voice volume
+
+**POST** `api/games/{gameId}/audio/voice-volume`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+Body type: `VolumeRequest`
+
+| Field | Type |
+| --- | --- |
+| `Volume` | `double` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.setVoiceVolume({
+    gameId: '<gameId>',
+    volume: 1.0
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `showCredits`
+
+Shows the credits screen
+
+**POST** `api/games/{gameId}/ui/credits`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.showCredits({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `showMainMenu`
+
+Shows the main menu
+
+**POST** `api/games/{gameId}/ui/main-menu`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.showMainMenu({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `showOptions`
+
+Shows the options menu
+
+**POST** `api/games/{gameId}/ui/options`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.showOptions({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `showTitleScreen`
+
+Shows the title screen
+
+**POST** `api/games/{gameId}/ui/title-screen`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.showTitleScreen({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `startGame`
+
+Starts a new game session
+
+**POST** `api/games/{gameId}/start`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.startGame({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `unloadArea`
+
+Unloads an area
+
+**POST** `api/games/{gameId}/areas/{areaId}/unload`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+| `areaId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.unloadArea({
+    gameId: '<gameId>',
+    areaId: '<areaId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `unloadGame`
+
+Unloads a game from memory
+
+**POST** `api/games/{gameId}/unload`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.unloadGame({
+    gameId: '<gameId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `unloadLevel`
+
+Unloads a specific level
+
+**POST** `api/games/{gameId}/levels/{level}/unload`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `gameId` | `Guid` |
+| `level` | `string` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.unloadLevel({
+    gameId: '<gameId>',
+    level: '<level>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `unpublishGame`
+
+Unpublishes a game from the STARNET system.
+
+**POST** `api/games/{id}/unpublish`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.unpublishGame({
+    id: '<id>',
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `updateGame`
+
+Updates an existing game.
+
+**PUT** `api/games/{id}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `IGame`
+
+| Field | Type |
+| --- | --- |
+| `GameType` | `GameType` |
+| `Version` | `string` |
+| `Developer` | `string` |
+| `Publisher` | `string` |
+| `ReleaseDate` | `DateTime` |
+| `SupportedPlatforms` | `List<string>` |
+| `SupportsCrossGameInterop` | `bool` |
+| `GameSettings` | `Dictionary<string, object>` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.games.updateGame({
+    id: '<id>',
+    gameType: {  },
+    version: "example string",
+    developer: "example string",
+    publisher: "example string",
+    releaseDate: "2026-01-01T00:00:00Z",
+    supportedPlatforms: ["example string"],
+    supportsCrossGameInterop: true,
+    gameSettings: { "<string>": {} }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+