ModCatalogController

ModCatalogController exposes ModDB browsing, catalog downloads, and downloaded-mod management to the frontend. It stays limited to DTO conversion and feature invocation.

• Methods: 16
• Referenced types: 13

Methods

• CancelModTask
• CheckModUpdates
• DownloadMod
• DownloadModsBatch
• GetMod
• InstallDownloadedMod
• ListDownloadedMods
• ListFavoriteModIDs
• ListFavoriteMods
• ListModTags
• PreviewUnusedDownloadedMods
• RemoveDownloadedMod
• RemoveUnusedDownloadedMods
• SearchMods
• SetModFavorite
• UploadMods

CancelModTask

CancelModTask requests cancellation of an active catalog download or upload.

Go

CancelModTask(taskID string) error

TypeScript

CancelModTask(taskID: string): Promise<void>

Parameters

Name	Type
taskID	string

Example

await CancelModTask("task-id")

Source

internal/transport/wails/mod_catalog_controller.go:241

CheckModUpdates

CheckModUpdates refreshes update information for cached releases of one catalog mod.

Go

CheckModUpdates(modID string) ([]DownloadedModDTO, error)

TypeScript

CheckModUpdates(modID: string): Promise<DownloadedModDTO[]>

Parameters

Name	Type
modID	string

Returns

Go type	TypeScript type
[]DownloadedModDTO	DownloadedModDTO[]

Example

const checkModUpdates = await CheckModUpdates("mod-id")

Source

internal/transport/wails/mod_catalog_controller.go:246

DownloadMod

DownloadMod downloads a catalog release and optionally installs it into selected instances. The call returns when the download task finishes; TaskID can be passed to CancelModTask, and per-instance installation failures are reported through Installations.

Go

DownloadMod(request DownloadCatalogModRequest) (ModInstallResultDTO, error)

TypeScript

DownloadMod(request: DownloadCatalogModRequest): Promise<ModInstallResultDTO>

Parameters

Name	Type
request	DownloadCatalogModRequest

Returns

Go type	TypeScript type
ModInstallResultDTO	ModInstallResultDTO

Errors

• mod_not_found: the mod does not exist in the catalog
• mod_version_not_found: the requested release does not exist
• mod_catalog_unavailable: the catalog could not be reached
• mod_incompatible: the release is incompatible with a target instance
• mod_download_already_active: a task for this release is already running
• invalid_mod_file: the downloaded archive is not a valid mod
• download_failed: the release could not be downloaded
• instance_not_found: a target instance does not exist
• game_version_not_found: a target instance has no installed game version
• snapshot_in_progress: a snapshot is currently being taken
• data_folder_busy: a data-folder relocation is in progress

Example

const downloadMod = await DownloadMod({ modId: "mod-id", versionId: "version-id", instanceIds: [], downloadOnly: false, allowIncompatible: false })

Source

internal/transport/wails/mod_catalog_controller.go:143

DownloadModsBatch

DownloadModsBatch downloads and installs several catalog releases for one instance.

Go

DownloadModsBatch(request DownloadModsBatchRequest) []BatchModInstallResultDTO

TypeScript

DownloadModsBatch(request: DownloadModsBatchRequest): Promise<BatchModInstallResultDTO[]>

Parameters

Name	Type
request	DownloadModsBatchRequest

Returns

Go type	TypeScript type
[]BatchModInstallResultDTO	BatchModInstallResultDTO[]

Example

const downloadModsBatch = await DownloadModsBatch({ instanceId: "instance-id", targets: [] })

Source

internal/transport/wails/mod_catalog_controller.go:174

GetMod

GetMod returns catalog details and available versions for one mod.

Go

GetMod(modID string) (ModDetailsDTO, error)

TypeScript

GetMod(modID: string): Promise<ModDetailsDTO>

Parameters

Name	Type
modID	string

Returns

Go type	TypeScript type
ModDetailsDTO	ModDetailsDTO

Example

const getMod = await GetMod("mod-id")

Source

internal/transport/wails/mod_catalog_controller.go:66

InstallDownloadedMod

InstallDownloadedMod installs an already cached catalog release into selected instances.

Go

InstallDownloadedMod(request InstallDownloadedModRequest) (ModInstallResultDTO, error)

TypeScript

InstallDownloadedMod(request: InstallDownloadedModRequest): Promise<ModInstallResultDTO>

Parameters

Name	Type
request	InstallDownloadedModRequest

Returns

Go type	TypeScript type
ModInstallResultDTO	ModInstallResultDTO

Example

const installDownloadedMod = await InstallDownloadedMod({ modId: "mod-id", versionId: "version-id", instanceIds: [], allowIncompatible: false })

Source

internal/transport/wails/mod_catalog_controller.go:202

ListDownloadedMods

ListDownloadedMods returns catalog mod files cached by the launcher.

Go

ListDownloadedMods() ([]DownloadedModDTO, error)

TypeScript

ListDownloadedMods(): Promise<DownloadedModDTO[]>

Returns

Go type	TypeScript type
[]DownloadedModDTO	DownloadedModDTO[]

Example

const listDownloadedMods = await ListDownloadedMods()

Source

internal/transport/wails/mod_catalog_controller.go:103

ListFavoriteModIDs

ListFavoriteModIDs returns locally stored favorite catalog IDs.

Go

ListFavoriteModIDs() ([]string, error)

TypeScript

ListFavoriteModIDs(): Promise<string[]>

Returns

Go type	TypeScript type
[]string	string[]

Example

const listFavoriteModIDs = await ListFavoriteModIDs()

Source

internal/transport/wails/mod_catalog_controller.go:72

ListFavoriteMods

ListFavoriteMods returns current catalog summaries for saved favorites.

Go

ListFavoriteMods() ([]ModSummaryDTO, error)

TypeScript

ListFavoriteMods(): Promise<ModSummaryDTO[]>

Returns

Go type	TypeScript type
[]ModSummaryDTO	ModSummaryDTO[]

Example

const listFavoriteMods = await ListFavoriteMods()

Source

internal/transport/wails/mod_catalog_controller.go:78

ListModTags

ListModTags returns catalog tags with their current result counts.

Go

ListModTags() ([]ModTagDTO, error)

TypeScript

ListModTags(): Promise<ModTagDTO[]>

Returns

Go type	TypeScript type
[]ModTagDTO	ModTagDTO[]

Example

const listModTags = await ListModTags()

Source

internal/transport/wails/mod_catalog_controller.go:93

PreviewUnusedDownloadedMods

PreviewUnusedDownloadedMods reports cached mod files that are not used by any instance.

Go

PreviewUnusedDownloadedMods() (DownloadedModCleanupResultDTO, error)

TypeScript

PreviewUnusedDownloadedMods(): Promise<DownloadedModCleanupResultDTO>

Returns

Go type	TypeScript type
DownloadedModCleanupResultDTO	DownloadedModCleanupResultDTO

Example

const previewUnusedDownloadedMods = await PreviewUnusedDownloadedMods()

Source

internal/transport/wails/mod_catalog_controller.go:221

RemoveDownloadedMod

RemoveDownloadedMod deletes a cached catalog release when it is safe to remove.

Go

RemoveDownloadedMod(modID string, versionID string) error

TypeScript

RemoveDownloadedMod(modID: string, versionID: string): Promise<void>

Parameters

Name	Type
modID	string
versionID	string

Example

await RemoveDownloadedMod("mod-id", "version-id")

Source

internal/transport/wails/mod_catalog_controller.go:213

RemoveUnusedDownloadedMods

RemoveUnusedDownloadedMods deletes cached mod files that are not used by any instance.

Go

RemoveUnusedDownloadedMods() (DownloadedModCleanupResultDTO, error)

TypeScript

RemoveUnusedDownloadedMods(): Promise<DownloadedModCleanupResultDTO>

Returns

Go type	TypeScript type
DownloadedModCleanupResultDTO	DownloadedModCleanupResultDTO

Example

const removeUnusedDownloadedMods = await RemoveUnusedDownloadedMods()

Source

internal/transport/wails/mod_catalog_controller.go:227

SearchMods

SearchMods queries the public mod catalog with filters, compatibility checks, and pagination.

Go

SearchMods(request ModSearchRequest) (ModSearchResultDTO, error)

TypeScript

SearchMods(request: ModSearchRequest): Promise<ModSearchResultDTO>

Parameters

Name	Type
request	ModSearchRequest

Returns

Go type	TypeScript type
ModSearchResultDTO	ModSearchResultDTO

Example

const searchMods = await SearchMods({ text: "", gameVersion: "1.0.0", side: "", tags: [], compatibleOnly: false, instanceId: "instance-id", sort: "", page: 0, pageSize: 0 })

Source

internal/transport/wails/mod_catalog_controller.go:37

SetModFavorite

SetModFavorite explicitly adds or removes a catalog mod favorite.

Go

SetModFavorite(modID string, favorite bool) error

TypeScript

SetModFavorite(modID: string, favorite: boolean): Promise<void>

Parameters

Name	Type
modID	string
favorite	bool

Example

await SetModFavorite("mod-id", false)

Source

internal/transport/wails/mod_catalog_controller.go:88

UploadMods

UploadMods uploads selected local mod archives to the catalog service.

Go

UploadMods(sourcePaths []string) (UploadModsResultDTO, error)

TypeScript

UploadMods(sourcePaths: string[]): Promise<UploadModsResultDTO>

Parameters

Name	Type
sourcePaths	[]string

Returns

Go type	TypeScript type
UploadModsResultDTO	UploadModsResultDTO

Example

const uploadMods = await UploadMods([])

Source

internal/transport/wails/mod_catalog_controller.go:233