Releases

Guides for managing editor-assets bundles.

A Release is a combination of an MSquared Editor and an Engine Plugin. A Release allows customers to distribute their own content to their own user base along with the editor all in one go. Using Releases, customers can create and iterate on their own development kits to allow users to easily create content and experiences with a familar theme and feel.

Right now, only one Engine Plugin can be bundles with an Editor to form a Release.

Each organisation currently only has one set of Releases and each new Release is considered an iterated version of the previous Release.

This means users are able to upgrade from one release to another even if they are unrelated and when a new Release is created, it must have a greater semantic version than the previous one.

A Release has the following information:

Field Name (*Required)	Description
Semantic Version	This must be a valid and increasing Semantic version.
Version Title	A human-readable title to give to your Release.
Editor Version	The editor version to be used with your Release.
Assets	The Assets Version (Engine Plugin) to bundle with the selected Editor Version for this release.
Release Channels	The channel within the Launcher for this Release editor to appear in. This can be edited after the Release has been published
Release Notes	A description of the changes in this Release. This can be edited after the Release has been published
Breaking Changes	A description of the changes that may cause breakages in user projects upgrading to this Release. This can be edited after the Release has been published

Limitations

• The Assets Version (Engine Plugin) must be created with the same editor that you wish to bundle it with.

Guides

Create a new Release

1. Downlaod the Editor that you wish to use as the Editor Version

2. Follow the guide to Create an Engine Plugin using this editor.

3. Navigate to the Releases page in the dashboard.

4. Click New.

5. Enter publish information for the new Release into the modal that opens.

6. Click Publish.

7. You can now download or upgrade to this Release from the Launcher (you may need to restart the launcher).

Consume a new Release

Users are able to consume new Releases via the Launcher