Skip to content

Wails API Methods

MethodControllerReturnsDescription
CancelLoginAccountControllervoidCancelLogin discards a pending sign-in flow.
CompleteTOTPAccountControllerLoginResultDTOCompleteTOTP finishes a sign-in flow with the user's one-time verification code.
ListAccountsAccountControllerAccountDTO[]ListAccounts returns the launcher's saved accounts for account selection.
LoginAccountControllerLoginResultDTOLogin starts an account sign-in flow and reports whether further verification is required.
ReauthenticateAccountAccountControllerLoginResultDTOReauthenticateAccount refreshes authentication for an existing saved account.
RemoveAccountAccountControllervoidRemoveAccount removes a saved account and its protected credentials.
SetDefaultAccountAccountControllervoidSetDefaultAccount selects the account used for future game launches.
ValidateAccountAccountControllerAccountDTOValidateAccount checks whether a saved account can still authenticate.
AppInfoAppControllerRecord<string, unknown>AppInfo returns launcher metadata needed by the application shell.
ConsumePendingDeepLinksDeepLinkControllerTarget[]ConsumePendingDeepLinks returns queued external navigation targets and clears the queue.
InstallLocalVersionGameVersionControllerOperationDTOInstallLocalVersion imports a game installation from a local archive or directory.
InstallVersionGameVersionControllerOperationDTOInstallVersion starts downloading and installing a selected game release.
ListAvailableVersionsGameVersionControllerAvailableGameVersionDTO[]ListAvailableVersions returns downloadable releases compatible with the current platform.
ListInstalledVersionsGameVersionControllerGameVersionDTO[]ListInstalledVersions returns game versions installed and managed by the launcher.
RemoveVersionGameVersionControllervoidRemoveVersion removes an installed game version when no managed instance requires it.
CloneInstanceInstanceControllerInstanceDTOCloneInstance creates a new managed instance by copying an existing instance.
CreateInstanceInstanceControllerInstanceDTOCreateInstance creates an isolated game instance using the requested version and launch settings.
DeleteInstanceInstanceControllervoidDeleteInstance removes an instance and optionally deletes its data directory.
DetectExistingVintageStoryDataInstanceControllerMigrationCandidateDTO[]DetectExistingVintageStoryData finds existing Vintage Story data that can be imported as an instance.
GetInstanceInstanceControllerInstanceDTOGetInstance returns one managed instance with its current mod and playtime summary.
InspectExistingVintageStoryDataInstanceControllerMigrationCandidateDTOInspectExistingVintageStoryData validates a selected data directory and describes its importable contents.
ListInstancesInstanceControllerInstanceDTO[]ListInstances returns all launcher instances visible in the library.
SelectInstanceCoverInstanceControllerstringSelectInstanceCover prompts for an image to use as an instance cover.
SetInstancePinnedInstanceControllerInstanceDTOSetInstancePinned changes whether an instance is pinned in the library.
StartExistingDataImportInstanceControllerOperationDTOStartExistingDataImport begins importing discovered game data into a managed instance.
UpdateInstanceInstanceControllerInstanceDTOUpdateInstance applies editable metadata, account, version, and launch settings to an instance.
ExportInstanceInstancePackageControllerPackageManifestDTOExportInstance writes a portable package containing sanitized instance data and metadata.
ImportPackageInstancePackageControllerOperationDTOImportPackage creates a managed instance from a validated package.
InspectPackageInstancePackageControllerPackageInspectionDTOInspectPackage validates a package and reports its contents before import.
SelectExportPathInstancePackageControllerstringSelectExportPath prompts for the destination of an exported instance package.
SelectPackageFileInstancePackageControllerstringSelectPackageFile prompts for an instance package to inspect or import.
GetInstanceLastKnownGoodLastKnownGoodControllerLastKnownGoodDTOGetInstanceLastKnownGood 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.
ForceStopInstanceLaunchControllervoidForceStopInstance terminates a running game or server process immediately.
GetRunningInstancesLaunchControllerstring[]GetRunningInstances returns identifiers for instances with active game or server processes.
LaunchInstanceLaunchControllerPlaySessionDTOLaunchInstance starts the game client with the instance's account and launch settings.
LaunchServerLaunchControllerPlaySessionDTOLaunchServer starts the dedicated server for an instance with the requested arguments.
StopInstanceLaunchControllervoidStopInstance requests a graceful stop of a running game or server process.
ValidateLaunchLaunchControllerLaunchValidationDTOValidateLaunch checks whether an instance can start and reports blocking problems.
CheckUpdatesLauncherUpdateControllerLauncherUpdateDTOCheckUpdates checks the selected release channel for a newer launcher version.
CurrentVersionLauncherUpdateControllerstringCurrentVersion returns the running launcher version for display and update comparison.
InstallUpdateLauncherUpdateControllervoidInstallUpdate downloads and applies the newest update from the selected channel.
OpenReleasePageLauncherUpdateControllervoidOpenReleasePage opens the selected update channel's release page.
OpenUrlLauncherUpdateControllervoidOpenUrl 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.
ExportLogsLogControllerstringExportLogs 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.
ListLogsLogControllerstring[]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.
OpenLogsDirectoryLogControllervoidOpenLogsDirectory opens the launcher's rolling log directory in the native
file manager, creating it when needed.
WriteLogLogControllervoidWriteLog 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.
CancelModTaskModCatalogControllervoidCancelModTask requests cancellation of an active catalog download or upload.
CheckModUpdatesModCatalogControllerDownloadedModDTO[]CheckModUpdates refreshes update information for cached releases of one catalog mod.
DownloadModModCatalogControllerModInstallResultDTODownloadMod downloads a catalog release and optionally installs it into selected instances.
DownloadModsBatchModCatalogControllerBatchModInstallResultDTO[]DownloadModsBatch downloads and installs several catalog releases for one instance.
GetModModCatalogControllerModDetailsDTOGetMod returns catalog details and available versions for one mod.
InstallDownloadedModModCatalogControllerModInstallResultDTOInstallDownloadedMod installs an already cached catalog release into selected instances.
ListDownloadedModsModCatalogControllerDownloadedModDTO[]ListDownloadedMods returns catalog mod files cached by the launcher.
ListModTagsModCatalogControllerModTagDTO[]ListModTags returns catalog tags with their current result counts.
PreviewUnusedDownloadedModsModCatalogControllerDownloadedModCleanupResultDTOPreviewUnusedDownloadedMods reports cached mod files that are not used by any instance.
RemoveDownloadedModModCatalogControllervoidRemoveDownloadedMod deletes a cached catalog release when it is safe to remove.
RemoveUnusedDownloadedModsModCatalogControllerDownloadedModCleanupResultDTORemoveUnusedDownloadedMods deletes cached mod files that are not used by any instance.
SearchModsModCatalogControllerModSearchResultDTOSearchMods queries the public mod catalog with filters, compatibility checks, and pagination.
UploadModsModCatalogControllerUploadModsResultDTOUploadMods uploads selected local mod archives to the catalog service.
CheckInstanceModUpdatesModManagerControllerInstanceModUpdateReportDTOCheckInstanceModUpdates finds compatible catalog updates for managed mods in an instance.
GetModDeletePreviewModManagerControllerModDeletePreviewDTOGetModDeletePreview reports dependent mods that would be affected by removal.
InstallModFileModManagerControllerOperationDTOInstallModFile installs one local mod archive into an instance.
InstallModFilesModManagerControllerInstallModFilesResultDTOInstallModFiles installs several local mod archives and reports individual failures.
LinkLocalModsModManagerControllerLinkLocalModsResultDTOLinkLocalMods links compatible cached mod files into an instance.
ListInstalledModsModManagerControllerInstalledModDTO[]ListInstalledMods returns mods installed in an instance and their enabled state.
RemoveModModManagerControllervoidRemoveMod removes an installed mod and optionally its dependent mods.
SetModEnabledModManagerControllerInstalledModDTOSetModEnabled enables or disables an installed mod for its owning instance.
SetModUpdatePolicyModManagerControllerInstalledModDTOSetModUpdatePolicy changes how a managed mod participates in automatic updates.
UpdateInstanceModsModManagerControllerModUpdateResultDTOUpdateInstanceMods 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.
MarkSeenNewsControllervoidMarkSeen records selected news entries as viewed by the user.
OpenArticleNewsControllervoidOpenArticle opens a verified news article in the user's browser.
SyncNewsControllerNewsFeedDTOSync refreshes the launcher news feed, optionally bypassing the local cache.
CancelOperationOperationControllervoidCancelOperation requests cancellation of a running background operation.
ClearOperationHistoryOperationControllernumberClearOperationHistory removes completed operation records and returns the count removed.
DeleteOperationOperationControllervoidDeleteOperation removes a completed operation from history.
ListOperationsOperationControllerOperationDTO[]ListOperations returns tracked background operations for progress and history views.
DeleteFavoriteServerServerControllervoidDeleteFavoriteServer removes a server from the user's favorites.
ListFavoriteServersServerControllerFavoriteServerDTO[]ListFavoriteServers returns the multiplayer servers saved by the user.
ListPublicServersServerControllerPublicServerDTO[]ListPublicServers returns the current public server catalog with joinability information.
SaveFavoriteServerServerControllerFavoriteServerDTOSaveFavoriteServer creates or updates a favorite server and its optional instance association.
DetectOptimumSettingsControllerOptimumStatusDTODetectOptimum searches standard locations for a usable Optimum installation.
GetDataFolderSettingsControllerDataFolderDTOGetDataFolder reports the active launcher data directory and its storage usage.
GetOptimumStatusSettingsControllerOptimumStatusDTOGetOptimumStatus reports the configured Optimum runtime and whether it is usable.
GetSettingsSettingsControllerSettingsDTOGetSettings returns the launcher's current user-configurable settings.
InspectOptimumSettingsControllerOptimumStatusDTOInspectOptimum validates a selected Optimum installation directory.
MoveDataFolderSettingsControllervoidMoveDataFolder relocates all launcher-managed data to the selected directory.
OpenDirectorySettingsControllervoidOpenDirectory opens an approved local directory in the system file manager.
OpenOptimumInstallationGuideSettingsControllervoidOpenOptimumInstallationGuide opens installation guidance for the optional Optimum runtime.
SelectDataFolderSettingsControllerstringSelectDataFolder prompts for a launcher data directory.
SelectGameArchiveSettingsControllerstringSelectGameArchive prompts for a local game archive.
SelectGameDirectorySettingsControllerstringSelectGameDirectory prompts for an existing game installation directory.
SelectModFileSettingsControllerstringSelectModFile prompts for one local mod archive.
SelectModFilesSettingsControllerstring[]SelectModFiles prompts for multiple local mod archives.
SelectOptimumInstallationSettingsControllerstringSelectOptimumInstallation prompts for an Optimum installation to inspect.
SetLibrarySortSettingsControllerSettingsDTOSetLibrarySort updates the ordering used by the instance library.
UpdateSettingsSettingsControllerSettingsDTOUpdateSettings validates and persists the complete settings document.
CreateInstanceSnapshotSnapshotControllerOperationDTOCreateInstanceSnapshot captures the current instance data as a restorable backup.
DeleteInstanceSnapshotSnapshotControllervoidDeleteInstanceSnapshot permanently removes a selected instance backup.
ListInstanceSnapshotsSnapshotControllerInstanceSnapshotDTO[]ListInstanceSnapshots returns restorable backups for an instance in newest-first order.
RestoreInstanceSnapshotSnapshotControllervoidRestoreInstanceSnapshot replaces current instance data with the selected backup.
GetOverviewStatisticsStatisticsControllerStatisticsDTOGetOverviewStatistics returns aggregate playtime, launch, instance, and mod statistics.
PreviewSupportReportControllerPreviewPreview creates a sanitized support-report snapshot for user review before submission.
SubmitSupportReportControllerResultSubmit uploads a previously reviewed support-report snapshot.