What's New?API StatusOur Website

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).

Assets Versions contain the following editable information:

Field Name (*Required)
Description

Description

An internal description for the Assets Version. 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.

Release

Assigning an associated release to an Assets Version will auto-fill the Compatible Releases list when publishing. Additional compatible releases may still be selected.

Dependencies

Authors may select other Assets that this Assets Version requires to function.

Assets Version dependencies are not enforced by the launcher yet.

Publishing Assets Versions

Publishing assets is only currently valid for Project Plugins. Engine plugins and Templates can be published but this serves no purpose.

For an Assets Versions to be downloadable for users in the Plugins page of the Launcher, it must first be published.

Assets Versions have the following editable publish information:

Field Name (*Required)
Description

Semantic version*

This must be a valid and increasing Semantic version. Once published, this information cannot be edited.

Compatible Releases

A list of Releases that this version is compatible with.

Experimental

A flag to show this Assets Version may be unstable

Release Notes

A markdown description for this Assets Version. 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.

Breaking Changes

A markdown description for anything that may have broken in user projects due to this Assets Version.

It is the responsibility of the Assets author to ensure the Compatible Releases field of every Assets Version is up-to-date with the current releases.

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:

  • Create a new Assets Version with fixes if anything has broken.

  • Add the new release to the Assets Versions Compatible Releases if everything still works as expected.

Limitations

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

Guides

Upload new Assets Version

Uploading a new Assets Version will depend on the Assets Type.

Edit an Assets Version

Editing an Assets Version is the same process for all Assets Types

  1. Navigate to the Assets where the Assets Version exists.

  2. Find the Assets Version you want to edit and press the edit button.

  3. Perform edits in the opened modal.

  4. Click Save.

Publish an Assets Version

Publishing an Assets Version is the same process for all Assets Types

  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.

  3. Enter publish information into the publish modal that opens.

  4. Click Publish.

Delete an Assets Version

The process for deleting an Assets is the same for all Assets Types.

  1. Navigate to the Assets Version you want to delete.

  2. Click the delete button.

  3. Confirm deletion of the Assets Version by clicking Delete.

PreviousAssetsNextEngine Plugins

Last updated

Was this helpful?