CreateInstanceRequest
CreateInstanceRequest defines the game version and options for a new instance.
Kind
struct
Fields
| Go field | JSON field | Go type | TypeScript type | Optional | Nullable | Description |
|---|---|---|---|---|---|---|
Name | name | string | string | No | No | Name is the user-visible instance name. |
Description | description | string | string | No | No | Description is the optional instance description. |
GameVersionID | gameVersionId | string | string | No | No | GameVersionID selects the installed game version for the instance. |
GameClient | gameClient | string | string | No | No | GameClient selects the runtime implementation: vanilla or optimum. |
DefaultAccountID | defaultAccountId | *string | string | null | Yes | Yes | DefaultAccountID is the account used when the instance launches without an explicit choice. |
Directory | directory | string | string | No | No | Directory is the instance data directory relative to the launcher data root. |
LaunchArguments | launchArguments | []string | string[] | No | No | LaunchArguments are extra command-line arguments appended at launch. |
EnvironmentVariables | environmentVariables | map[string]string | Record<string, string> | No | No | EnvironmentVariables are additional environment values applied at launch. |
Used by
- InstanceController.CreateInstance — parameter
request
Source
internal/transport/wails/instance_controller.go:147