Skip to content

Get Latest Mod Release

Stable

Getting the latest mod release returns the most recently created public release for a mod. The Daemon calls this endpoint when a user requests installation of a mod to obtain the assets, symbolic link definitions, and mission scripts needed to install it.

PropertyValue
Applies toWebapp
TriggerDaemon requests the latest release for a mod prior to installation
PreconditionsNone

Inputs

id : String, required (path parameter). The identifier of the mod.

Assertions

AssertionStatus
None — the operation proceeds for any mod identifier

Outputs

Result<ModReleaseData, ReleaseNotFoundError> : On success, returns the full release record including assets, symbolic link definitions, and mission scripts. On failure, returns:

ReleaseNotFoundError : The mod does not exist, or the mod has no public releases. Both cases return the same error — there is no separate ModNotFoundError path.

Effects

None. This is a read-only operation.

Behavior

mermaid
flowchart TD
    Start([findLatestPublicModRelease id]) --> Query[modRepository.findLatestPublicModRelease id]

    Query --> Found{Release found?}

    Found -- No --> ErrNotFound([Err: ReleaseNotFoundError])
    Found -- Yes --> Done([Ok: ModReleaseData])

    style ErrNotFound fill:#f87171,color:#fff
    style Done fill:#4ade80,color:#000

See Also

  • Register mod release download — Spec page for the call the Daemon makes after a successful installation.
  • Add Release — Spec page for the Daemon behavior that consumes the release data returned here.
  • Update release — Spec page for how maintainers populate the assets and symlink definitions returned by this endpoint.
  • How the Webapp works — Guide covering release structure and how the Daemon uses it.