Skip to content

CreateInstanceRequest

CreateInstanceRequest defines the game version and options for a new instance.

Kind

struct

Fields

Go fieldJSON fieldGo typeTypeScript typeOptionalNullableDescription
NamenamestringstringNoNoName is the user-visible instance name.
DescriptiondescriptionstringstringNoNoDescription is the optional instance description.
GameVersionIDgameVersionIdstringstringNoNoGameVersionID selects the installed game version for the instance.
GameClientgameClientstringstringNoNoGameClient selects the runtime implementation: vanilla or optimum.
DefaultAccountIDdefaultAccountId*stringstring | nullYesYesDefaultAccountID is the account used when the instance launches without an explicit choice.
DirectorydirectorystringstringNoNoDirectory is the instance data directory relative to the launcher data root.
LaunchArgumentslaunchArguments[]stringstring[]NoNoLaunchArguments are extra command-line arguments appended at launch.
EnvironmentVariablesenvironmentVariablesmap[string]stringRecord<string, string>NoNoEnvironmentVariables are additional environment values applied at launch.

Used by

Source

internal/transport/wails/instance_controller.go:147