Add Release

Stable

Adding a release registers it with the Daemon and begins downloading and extracting its assets so the mod can later be enabled in DCS World.

Property	Value
Applies to	Daemon
Trigger	User requests installation of a release from the registry
Preconditions	The mods directory is configured and exists on disk

Inputs

releaseId : String, required. The identifier of the release to add.

modId : String, required. The identifier of the mod the release belongs to.

modName : String, required. The display name of the mod.

version : String, required. The version string of the release.

assets : List, required. The downloadable assets for this release. Each asset includes a name, one or more download URLs, and whether it is an archive that should be extracted after download.

symbolicLinks : List, required. The symlink definitions for this release. Each definition specifies a source path within the release, a destination path, and which DCS World root directory the destination is relative to.

missionScripts : List, optional. Mission script definitions bundled with the release. Each definition specifies a script path, where it should be placed, and when it should run.

dependencies : List, optional. Identifiers of other mods this release depends on.

Assertions

Assertion	Status
The mods directory must be configured	Implemented
The mods directory must exist on disk	Implemented

Outputs

Result<void, DropzoneModsDirNotConfigured> : On success, returns void. On failure, returns the following error type:

DropzoneModsDirNotConfigured : The mods directory has not been configured or does not exist on disk. No release is recorded.

Effects

Effect	Status
A directory is created in the mods directory for the release	Implemented
The release, its assets, symlink definitions, and mission scripts are recorded in the Daemon's local store	Implemented
A download job is queued for each asset URL	Implemented
For each archive asset, an extract job is queued in `PENDING` state	Implemented
Extract jobs move to `WAITING` once all downloads complete	Implemented
On download failure, the failed asset is marked as `ERROR` with an error code and human-readable message	Implemented
On extraction failure, the failed asset is marked as `ERROR` with an error code and human-readable message	Implemented

Behavior

mermaid

flowchart TD
    Start([addRelease data]) --> CheckDir{Mods directory<br/>configured?}

    CheckDir -- No --> ErrModsDir([Reject: DropzoneModsDirNotConfigured])
    CheckDir -- Yes --> ExistsOnDisk{Mods directory<br/>exists on disk?}

    ExistsOnDisk -- No --> ErrModsDir
    ExistsOnDisk -- Yes --> CreateDir[Create release directory]

    CreateDir --> SaveRelease[Record release, assets,<br/>symlinks, mission scripts<br/>in local store]

    SaveRelease --> AssetLoop{More assets?}

    AssetLoop -- No --> Done([Release in PENDING state])
    AssetLoop -- Yes --> QueueDownload[Queue download job<br/>for each URL on asset]

    QueueDownload --> IsArchive{Asset is archive?}

    IsArchive -- Yes --> QueueExtract[Queue extract job<br/>in PENDING state]
    IsArchive -- No --> AssetLoop

    QueueExtract --> AssetLoop

    Done --> Processing[Jobs process asynchronously]

    Processing --> AllDownloads{All downloads<br/>succeeded?}

    AllDownloads -- Yes --> MoveExtracts[Move extract jobs<br/>from PENDING to WAITING]
    AllDownloads -- No --> DownloadFail[Mark failed asset as ERROR<br/>with error code and message]

    DownloadFail --> ReleaseError([Release reaches ERROR state])

    MoveExtracts --> AllExtracts{All extractions<br/>succeeded?}

    AllExtracts -- Yes --> ReleaseReady([Release reaches DISABLED state])
    AllExtracts -- No --> ExtractFail[Mark failed asset as ERROR<br/>with error code and message]

    ExtractFail --> ReleaseError

    style ErrModsDir fill:#f87171,color:#fff
    style DownloadFail fill:#f87171,color:#fff
    style ExtractFail fill:#f87171,color:#fff
    style ReleaseError fill:#f87171,color:#fff
    style ReleaseReady fill:#4ade80,color:#000
    style Done fill:#60a5fa,color:#000

Add Release ​

Inputs ​

Assertions ​

Outputs ​

Effects ​

Behavior ​