Wails API Methods
| Method | Controller | Returns | Description |
|---|---|---|---|
| CancelLogin | AccountController | void | CancelLogin discards a pending sign-in flow. |
| CompleteTOTP | AccountController | LoginResultDTO | CompleteTOTP finishes a sign-in flow with the user's one-time verification code. |
| ListAccounts | AccountController | AccountDTO[] | ListAccounts returns the launcher's saved accounts for account selection. |
| Login | AccountController | LoginResultDTO | Login starts an account sign-in flow and reports whether further verification is required. |
| ReauthenticateAccount | AccountController | LoginResultDTO | ReauthenticateAccount refreshes authentication for an existing saved account. |
| RemoveAccount | AccountController | void | RemoveAccount removes a saved account and its protected credentials. |
| SetDefaultAccount | AccountController | void | SetDefaultAccount selects the account used for future game launches. |
| ValidateAccount | AccountController | AccountDTO | ValidateAccount checks whether a saved account can still authenticate. |
| AppInfo | AppController | Record<string, unknown> | AppInfo returns launcher metadata needed by the application shell. |
| ConsumePendingDeepLinks | DeepLinkController | Target[] | ConsumePendingDeepLinks returns queued external navigation targets and clears the queue. |
| InstallLocalVersion | GameVersionController | OperationDTO | InstallLocalVersion imports a game installation from a local archive or directory. |
| InstallVersion | GameVersionController | OperationDTO | InstallVersion starts downloading and installing a selected game release. |
| ListAvailableVersions | GameVersionController | AvailableGameVersionDTO[] | ListAvailableVersions returns downloadable releases compatible with the current platform. |
| ListInstalledVersions | GameVersionController | GameVersionDTO[] | ListInstalledVersions returns game versions installed and managed by the launcher. |
| RemoveVersion | GameVersionController | void | RemoveVersion removes an installed game version when no managed instance requires it. |
| CloneInstance | InstanceController | InstanceDTO | CloneInstance creates a new managed instance by copying an existing instance. |
| CreateInstance | InstanceController | InstanceDTO | CreateInstance creates an isolated game instance using the requested version and launch settings. |
| DeleteInstance | InstanceController | void | DeleteInstance removes an instance and optionally deletes its data directory. |
| DetectExistingVintageStoryData | InstanceController | MigrationCandidateDTO[] | DetectExistingVintageStoryData finds existing Vintage Story data that can be imported as an instance. |
| GetInstance | InstanceController | InstanceDTO | GetInstance returns one managed instance with its current mod and playtime summary. |
| InspectExistingVintageStoryData | InstanceController | MigrationCandidateDTO | InspectExistingVintageStoryData validates a selected data directory and describes its importable contents. |
| ListInstances | InstanceController | InstanceDTO[] | ListInstances returns all launcher instances visible in the library. |
| SelectInstanceCover | InstanceController | string | SelectInstanceCover prompts for an image to use as an instance cover. |
| SetInstancePinned | InstanceController | InstanceDTO | SetInstancePinned changes whether an instance is pinned in the library. |
| StartExistingDataImport | InstanceController | OperationDTO | StartExistingDataImport begins importing discovered game data into a managed instance. |
| UpdateInstance | InstanceController | InstanceDTO | UpdateInstance applies editable metadata, account, version, and launch settings to an instance. |
| ExportInstance | InstancePackageController | PackageManifestDTO | ExportInstance writes a portable package containing sanitized instance data and metadata. |
| ImportPackage | InstancePackageController | OperationDTO | ImportPackage creates a managed instance from a validated package. |
| InspectPackage | InstancePackageController | PackageInspectionDTO | InspectPackage validates a package and reports its contents before import. |
| SelectExportPath | InstancePackageController | string | SelectExportPath prompts for the destination of an exported instance package. |
| SelectPackageFile | InstancePackageController | string | SelectPackageFile prompts for an instance package to inspect or import. |
| GetInstanceLastKnownGood | LastKnownGoodController | LastKnownGoodDTO | GetInstanceLastKnownGood returns the Last Known Good marker of an instance together with the comparison against its current configuration. A zero DTO with no error means no marker was recorded yet. |
| ForceStopInstance | LaunchController | void | ForceStopInstance terminates a running game or server process immediately. |
| GetRunningInstances | LaunchController | string[] | GetRunningInstances returns identifiers for instances with active game or server processes. |
| LaunchInstance | LaunchController | PlaySessionDTO | LaunchInstance starts the game client with the instance's account and launch settings. |
| LaunchServer | LaunchController | PlaySessionDTO | LaunchServer starts the dedicated server for an instance with the requested arguments. |
| StopInstance | LaunchController | void | StopInstance requests a graceful stop of a running game or server process. |
| ValidateLaunch | LaunchController | LaunchValidationDTO | ValidateLaunch checks whether an instance can start and reports blocking problems. |
| CheckUpdates | LauncherUpdateController | LauncherUpdateDTO | CheckUpdates checks the selected release channel for a newer launcher version. |
| CurrentVersion | LauncherUpdateController | string | CurrentVersion returns the running launcher version for display and update comparison. |
| InstallUpdate | LauncherUpdateController | void | InstallUpdate downloads and applies the newest update from the selected channel. |
| OpenReleasePage | LauncherUpdateController | void | OpenReleasePage opens the selected update channel's release page. |
| OpenUrl | LauncherUpdateController | void | OpenUrl opens an http(s) link in the user's default browser. Only well-formed web links are accepted; any other scheme or a missing host is rejected. |
| ExportLogs | LogController | string | ExportLogs asks the user for a destination and writes a support log file containing a system summary and the recent launcher log. It returns the saved path, or an empty string when the user cancels the dialog. Sensitive values never reach the file: the log buffer is redacted on write and the summary carries no credentials or machine-specific paths. |
| ListLogs | LogController | string[] | ListLogs returns the most recent log lines rendered for the console. The newest lines come last. Lines are ANSI-colored so an xterm-style viewer can display them directly. |
| OpenLogsDirectory | LogController | void | OpenLogsDirectory opens the launcher's rolling log directory in the native file manager, creating it when needed. |
| WriteLog | LogController | void | WriteLog routes a log entry reported from the frontend into the launcher's logging pipeline (in-memory console, live push, session file, support export). The level must be one of "debug", "info", "warn" or "error"; messages are length-capped and sensitive values are redacted like any other log line. Attrs are attached as key/value pairs; the entry is marked with source=frontend so UI-originated lines are distinguishable. |
| CancelModTask | ModCatalogController | void | CancelModTask requests cancellation of an active catalog download or upload. |
| CheckModUpdates | ModCatalogController | DownloadedModDTO[] | CheckModUpdates refreshes update information for cached releases of one catalog mod. |
| DownloadMod | ModCatalogController | ModInstallResultDTO | DownloadMod downloads a catalog release and optionally installs it into selected instances. |
| DownloadModsBatch | ModCatalogController | BatchModInstallResultDTO[] | DownloadModsBatch downloads and installs several catalog releases for one instance. |
| GetMod | ModCatalogController | ModDetailsDTO | GetMod returns catalog details and available versions for one mod. |
| InstallDownloadedMod | ModCatalogController | ModInstallResultDTO | InstallDownloadedMod installs an already cached catalog release into selected instances. |
| ListDownloadedMods | ModCatalogController | DownloadedModDTO[] | ListDownloadedMods returns catalog mod files cached by the launcher. |
| ListModTags | ModCatalogController | ModTagDTO[] | ListModTags returns catalog tags with their current result counts. |
| PreviewUnusedDownloadedMods | ModCatalogController | DownloadedModCleanupResultDTO | PreviewUnusedDownloadedMods reports cached mod files that are not used by any instance. |
| RemoveDownloadedMod | ModCatalogController | void | RemoveDownloadedMod deletes a cached catalog release when it is safe to remove. |
| RemoveUnusedDownloadedMods | ModCatalogController | DownloadedModCleanupResultDTO | RemoveUnusedDownloadedMods deletes cached mod files that are not used by any instance. |
| SearchMods | ModCatalogController | ModSearchResultDTO | SearchMods queries the public mod catalog with filters, compatibility checks, and pagination. |
| UploadMods | ModCatalogController | UploadModsResultDTO | UploadMods uploads selected local mod archives to the catalog service. |
| CheckInstanceModUpdates | ModManagerController | InstanceModUpdateReportDTO | CheckInstanceModUpdates finds compatible catalog updates for managed mods in an instance. |
| GetModDeletePreview | ModManagerController | ModDeletePreviewDTO | GetModDeletePreview reports dependent mods that would be affected by removal. |
| InstallModFile | ModManagerController | OperationDTO | InstallModFile installs one local mod archive into an instance. |
| InstallModFiles | ModManagerController | InstallModFilesResultDTO | InstallModFiles installs several local mod archives and reports individual failures. |
| LinkLocalMods | ModManagerController | LinkLocalModsResultDTO | LinkLocalMods links compatible cached mod files into an instance. |
| ListInstalledMods | ModManagerController | InstalledModDTO[] | ListInstalledMods returns mods installed in an instance and their enabled state. |
| RemoveMod | ModManagerController | void | RemoveMod removes an installed mod and optionally its dependent mods. |
| SetModEnabled | ModManagerController | InstalledModDTO | SetModEnabled enables or disables an installed mod for its owning instance. |
| SetModUpdatePolicy | ModManagerController | InstalledModDTO | SetModUpdatePolicy changes how a managed mod participates in automatic updates. |
| UpdateInstanceMods | ModManagerController | ModUpdateResultDTO | UpdateInstanceMods updates several installed mods of one instance in a single coordinated operation; the backend creates exactly one automatic safety snapshot before the first update is applied. |
| MarkSeen | NewsController | void | MarkSeen records selected news entries as viewed by the user. |
| OpenArticle | NewsController | void | OpenArticle opens a verified news article in the user's browser. |
| Sync | NewsController | NewsFeedDTO | Sync refreshes the launcher news feed, optionally bypassing the local cache. |
| CancelOperation | OperationController | void | CancelOperation requests cancellation of a running background operation. |
| ClearOperationHistory | OperationController | number | ClearOperationHistory removes completed operation records and returns the count removed. |
| DeleteOperation | OperationController | void | DeleteOperation removes a completed operation from history. |
| ListOperations | OperationController | OperationDTO[] | ListOperations returns tracked background operations for progress and history views. |
| DeleteFavoriteServer | ServerController | void | DeleteFavoriteServer removes a server from the user's favorites. |
| ListFavoriteServers | ServerController | FavoriteServerDTO[] | ListFavoriteServers returns the multiplayer servers saved by the user. |
| ListPublicServers | ServerController | PublicServerDTO[] | ListPublicServers returns the current public server catalog with joinability information. |
| SaveFavoriteServer | ServerController | FavoriteServerDTO | SaveFavoriteServer creates or updates a favorite server and its optional instance association. |
| DetectOptimum | SettingsController | OptimumStatusDTO | DetectOptimum searches standard locations for a usable Optimum installation. |
| GetDataFolder | SettingsController | DataFolderDTO | GetDataFolder reports the active launcher data directory and its storage usage. |
| GetOptimumStatus | SettingsController | OptimumStatusDTO | GetOptimumStatus reports the configured Optimum runtime and whether it is usable. |
| GetSettings | SettingsController | SettingsDTO | GetSettings returns the launcher's current user-configurable settings. |
| InspectOptimum | SettingsController | OptimumStatusDTO | InspectOptimum validates a selected Optimum installation directory. |
| MoveDataFolder | SettingsController | void | MoveDataFolder relocates all launcher-managed data to the selected directory. |
| OpenDirectory | SettingsController | void | OpenDirectory opens an approved local directory in the system file manager. |
| OpenOptimumInstallationGuide | SettingsController | void | OpenOptimumInstallationGuide opens installation guidance for the optional Optimum runtime. |
| SelectDataFolder | SettingsController | string | SelectDataFolder prompts for a launcher data directory. |
| SelectGameArchive | SettingsController | string | SelectGameArchive prompts for a local game archive. |
| SelectGameDirectory | SettingsController | string | SelectGameDirectory prompts for an existing game installation directory. |
| SelectModFile | SettingsController | string | SelectModFile prompts for one local mod archive. |
| SelectModFiles | SettingsController | string[] | SelectModFiles prompts for multiple local mod archives. |
| SelectOptimumInstallation | SettingsController | string | SelectOptimumInstallation prompts for an Optimum installation to inspect. |
| SetLibrarySort | SettingsController | SettingsDTO | SetLibrarySort updates the ordering used by the instance library. |
| UpdateSettings | SettingsController | SettingsDTO | UpdateSettings validates and persists the complete settings document. |
| CreateInstanceSnapshot | SnapshotController | OperationDTO | CreateInstanceSnapshot captures the current instance data as a restorable backup. |
| DeleteInstanceSnapshot | SnapshotController | void | DeleteInstanceSnapshot permanently removes a selected instance backup. |
| ListInstanceSnapshots | SnapshotController | InstanceSnapshotDTO[] | ListInstanceSnapshots returns restorable backups for an instance in newest-first order. |
| RestoreInstanceSnapshot | SnapshotController | void | RestoreInstanceSnapshot replaces current instance data with the selected backup. |
| GetOverviewStatistics | StatisticsController | StatisticsDTO | GetOverviewStatistics returns aggregate playtime, launch, instance, and mod statistics. |
| Preview | SupportReportController | Preview | Preview creates a sanitized support-report snapshot for user review before submission. |
| Submit | SupportReportController | Result | Submit uploads a previously reviewed support-report snapshot. |