Page MenuHomeAnticto

Mutable for Unreal Engine | Step by step set up of a project using Mutable
Updated 2 Days AgoPublic

This guide will show how to set up a fully featured Mutable in a source code version of Unreal Engine.

1) Get a clean working copy of the matching Unreal Engine version, for example 5.0.1. Each release of Mutable targets a specific engine version. Follow the step 1. of the official install instructions from Epic. For example, if you are using TortoiseGIT, you should clone with the following options to select a branch:

TortoiseGIt.jpg (531×722 px, 69 KB)

Modify the branch name so it matches the one targeted by the Mutable release you are using.
If the release targets a specific commit hash, now it's the time to checkout to that commit. With TortoiseGIT, this would be the checkout dialog for release 1.6.2:

image.png (639×765 px, 32 KB)

When you are sure that you are on the correct branch, tag or commit that is referenced in the Mutable download page, continue.

2) Download and apply the necessary engine patch. The patch can be downloaded on every platform download page. For example this page is for Windows platform. Access to some platforms may be restricted based on your license. To apply the patch, there are several options:

  • Option 1: Using TortoiseGIT: In Windows, you can use TortoiseGit option Review/apply single patch for interactive application of the patch.
    Mutable-Doc-Patch.png (721×708 px, 159 KB)
    Then select the option Patch all intems:
    imatge.png (534×526 px, 29 KB)
    And then you can close the TortoiseGIT window.
WARNING: If you get error messages when applying the patch, please make sure you cloned the Unreal Engine tag that matches the release of Mutable that you downloaded. The tag for each version is specified in each download page.
  • Option 2: Using a Terminal: use the git apply command. For example:
c:\projects\UnrealEngine> git apply Anticto-UnrealEngine-MutableVersion-EngineVersion.patch

3) Download and unzip the Mutable plugin in unreal engine Plugins folder. At the end, the file "Mutable.uplugin" should be in a path like this:

<YourUnrealEngineInstallationDirectory>/Engine/Plugins/Mutable/Mutable.uplugin

image (2).png (453×1 px, 42 KB)

4) Build the new engine, following the official instructions steps 3. to 6. inclusive. This involves running Setup.bat, GenerateProjectFiles.bat and building from Visual Studio.

5) Create your Unreal C++ project.

  • Option 1 Create a new project. You can do this by launching the new Unreal Engine Editor in this working copy and creating a new project. You will need to enable the plugin. Go to the main menu EditPlugins dialog, and look for "Mutable". A restart of the editor may be necessary after activating it.
  • Option 2 Use one of the demo projects distributed with Mutable. Download the Village or Cyborg demo projects from this site, and unzip them. You will need to associate the Unreal projects of the demo with the Unreal Engine that you have just created from the context menu of the file explorer.
Last Author
ricard
Last Edited
Wed, May 25, 12:10 PM

Event Timeline

jordi shifted this object from the S3 Public space to the S6 Mutable for Unreal Engine space.
jordi edited the content of this document. (Show Details)
jordi edited the content of this document. (Show Details)
marc edited the content of this document. (Show Details)
jordi edited the content of this document. (Show Details)
jordi edited the content of this document. (Show Details)
jordi edited the content of this document. (Show Details)
jordi edited the content of this document. (Show Details)
jordi edited the content of this document. (Show Details)
jordi changed the visibility from "All Users" to "Public (No Login Required)".Jun 10 2020, 11:24 AM
pep published a new version of this document.
genis published a new version of this document.Nov 20 2020, 3:01 PM