# Assets Versions

An `Assets Version` is a snapshots of Unreal Engine content that users are able to download and use, once published (see [Assets Types](https://docs.msquared.io/apis-and-tooling/dashboard/assets/..#assets-types)).

Assets Versions contain the following editable information:

<table><thead><tr><th width="216">Field Name (*Required)</th><th>Description</th></tr></thead><tbody><tr><td>Description</td><td>An internal description for the Assets Version.<br><br>This should be used to help the author track what the purpose of the Assets Version. Users will see the published release notes rather than this information.</td></tr><tr><td>Release</td><td>Assigning an associated release to an Assets Version will auto-fill the Compatible Releases list when publishing. Additional compatible releases may still be selected.</td></tr><tr><td>Dependencies</td><td>Authors may select other Assets that this Assets Version requires to function.</td></tr></tbody></table>

{% hint style="warning" %} <mark style="color:orange;">Assets Version dependencies are not enforced by the launcher yet.</mark>
{% endhint %}

## Publishing Assets Versions

{% hint style="warning" %} <mark style="color:orange;">Publishing assets is only currently valid for Project Plugins. Engine plugins and Templates can be published but this serves no purpose.</mark>
{% endhint %}

{% hint style="info" %} <mark style="color:blue;">For an Assets Versions to be downloadable for users in the</mark> [<mark style="color:blue;">Plugins page of the Launcher</mark>](https://docs.msquared.io/apis-and-tooling/launcher/msquared-launcher/plugins)<mark style="color:blue;">, it must first be published.</mark>
{% endhint %}

Assets Versions have the following editable publish information:

<table><thead><tr><th width="215">Field Name (*Required)</th><th>Description</th></tr></thead><tbody><tr><td>Semantic version*</td><td>This must be a valid and increasing <a href="https://semver.org/">Semantic version</a>.<br><br><strong>Once published, this information cannot be edited.</strong></td></tr><tr><td>Compatible Releases</td><td>A list of <a href="../releases">Releases</a> that this version is compatible with.</td></tr><tr><td>Experimental</td><td>A flag to show this Assets Version may be unstable</td></tr><tr><td>Release Notes</td><td>A <code>markdown</code> description for this Assets Version.<br><br>As this is markdown, the author may wish to embed media to better show what fixes, changes or additions have arrived in the new Assets Version.</td></tr><tr><td>Breaking Changes</td><td>A <code>markdown</code> description for anything that may have broken in user projects due to this Assets Version.</td></tr></tbody></table>

{% hint style="warning" %} <mark style="color:orange;">It is the responsibility of the Assets author to ensure the</mark> <mark style="color:orange;">`Compatible Releases`</mark> <mark style="color:orange;">field of every Assets Version is up-to-date with the current releases.</mark>

<mark style="color:orange;">Likewise, when a new release is created, it is the responsibility of the author to check their Assets Versions against the new release and either:</mark>

* <mark style="color:orange;">Create a new Assets Version with fixes if anything has broken.</mark>
* <mark style="color:orange;">Add the new release to the Assets Versions</mark> <mark style="color:orange;">`Compatible Releases`</mark> <mark style="color:orange;">if everything still works as expected.</mark>
  {% endhint %}

## Limitations

* We do now allow Assets Versions to be deleted if they have been published

## Guides

<details>

<summary>Upload new Assets Version</summary>

Uploading a new Assets Version will depend on the [Assets Type](https://docs.msquared.io/apis-and-tooling/dashboard/assets/..#assets-types).

* [Upload a new Engine Plugin Assets Version](https://docs.msquared.io/apis-and-tooling/dashboard/engine-plugins#uploade-a-new-engine-plugin-assets-version)
* [Upload a new Project Plugin Assets Version](https://docs.msquared.io/apis-and-tooling/dashboard/project-plugins#uploade-a-new-project-plugin-assets-version)
* [Upload a new Template Assets Version](https://docs.msquared.io/apis-and-tooling/dashboard/templates#uploade-a-new-template-assets-version)

</details>

<details>

<summary>Edit an Assets Version</summary>

{% hint style="info" %} <mark style="color:blue;">Editing an Assets Version is the same process for all Assets Types</mark>
{% endhint %}

1. Navigate to the Assets where the Assets Version exists.
2. Find the Assets Version you want to edit and press the edit button.\
   \
   ![](https://1456550285-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoWTlPaoHd1McSakqMigu%2Fuploads%2Fgit-blob-4266d7bcfd8bafb0d63d5a0abb9ea876c2e2e122%2Fimage.png?alt=media)\\
3. Perform edits in the opened modal.\
   \
   \\
4. Click `Save`.

</details>

<details>

<summary>Publish an Assets Version</summary>

{% hint style="info" %} <mark style="color:blue;">Publishing an Assets Version is the same process for all Assets Types</mark>
{% endhint %}

1. Navigate to the Assets where the Assets Version you want to publish exists.
2. Find the Assets Version you want to publish and click the `Publish` button.\
   \
   ![](https://1456550285-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoWTlPaoHd1McSakqMigu%2Fuploads%2Fgit-blob-96c93ef25fd8638a693ee194b0d5c1ba8805b1bb%2Fimage.png?alt=media)\\
3. Enter publish information into the publish modal that opens.
4. Click `Publish`.\
   \
   ![](https://1456550285-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoWTlPaoHd1McSakqMigu%2Fuploads%2Fgit-blob-c9bd6ec72b5863e6c0e2b814854e54ff9d062d8a%2Fimage.png?alt=media)

</details>

<details>

<summary>Delete an Assets Version</summary>

{% hint style="info" %} <mark style="color:blue;">The process for deleting an Assets is the same for all Assets Types.</mark>
{% endhint %}

1. Navigate to the Assets Version you want to delete.\
   \
   ![](https://1456550285-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoWTlPaoHd1McSakqMigu%2Fuploads%2Fgit-blob-f4014395134aa018bb4a4316dce94652bcc3dfe0%2Fimage.png?alt=media)\\
2. Click the delete button.
3. Confirm deletion of the Assets Version by clicking `Delete`.\
   \
   ![](https://1456550285-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoWTlPaoHd1McSakqMigu%2Fuploads%2Fgit-blob-7ac843c1bf0d3140078b951d53bb72327d48a2f5%2Fimage.png?alt=media)

</details>