Raymond Maarloeve
Loading...
Searching...
No Matches
GameConfig Class Reference

Represents the configuration for the game, including settings for the LLM server, window dimensions, models, and NPCs. This configuration is provided by the game launcher. More...

Static Public Member Functions

static GameConfig LoadGameConfig (string configPath)
 Loads the game configuration from a JSON file at the specified path. If the file does not exist or is invalid, a default configuration is returned.
 

Public Attributes

int Revision
 Revision number of the configuration file.
 
string LlmServerApi
 API endpoint for the LLM server.
 
bool FullScreen
 Indicates whether the game should run in fullscreen mode.
 
int GameWindowWidth
 Width of the game window.
 
int GameWindowHeight
 Height of the game window.
 
List< ModelConfigModels
 List of model configurations used in the game.
 
List< NpcConfigNpcs
 List of NPC configurations used in the game.
 
int NarratorModelId
 ID of the model used by the narrator.
 
int Seed = 0
 Custom seed for the game, set if value other than 0.
 

Detailed Description

Represents the configuration for the game, including settings for the LLM server, window dimensions, models, and NPCs. This configuration is provided by the game launcher.

Member Function Documentation

◆ LoadGameConfig()

static GameConfig GameConfig.LoadGameConfig ( string  configPath)
static

Loads the game configuration from a JSON file at the specified path. If the file does not exist or is invalid, a default configuration is returned.

Parameters
configPathPath to the configuration file.
Returns
A GameConfig object containing the loaded or default configuration.

Member Data Documentation

◆ FullScreen

bool GameConfig.FullScreen

Indicates whether the game should run in fullscreen mode.

◆ GameWindowHeight

int GameConfig.GameWindowHeight

Height of the game window.

◆ GameWindowWidth

int GameConfig.GameWindowWidth

Width of the game window.

◆ LlmServerApi

string GameConfig.LlmServerApi

API endpoint for the LLM server.

◆ Models

List<ModelConfig> GameConfig.Models

List of model configurations used in the game.

◆ NarratorModelId

int GameConfig.NarratorModelId

ID of the model used by the narrator.

◆ Npcs

List<NpcConfig> GameConfig.Npcs

List of NPC configurations used in the game.

◆ Revision

int GameConfig.Revision

Revision number of the configuration file.

◆ Seed

int GameConfig.Seed = 0

Custom seed for the game, set if value other than 0.


The documentation for this class was generated from the following file: