Main Content

Package Custom Scenes into Executable

When you finish modifying a custom scene as described in Customize Scenes Using Simulink and Unreal Editor, you can package the project file containing this scene into an executable. You can then configure your model to simulate from this executable by using the Simulation 3D Scene Configuration block. Executable files can improve simulation performance and do not require opening the Unreal® Editor to simulate your scene. Instead, the scene runs by using the Unreal Engine® that comes installed with Vehicle Dynamics Blockset™.

Package Scene into Executable Using Unreal Editor

Before packaging the custom scenes into an executable, make sure that the plugins are:

  • Located in the Unreal Engine installation area, for example, C:\Program Files\Epic Games\UE_5.1\Engine\Plugins\Marketplace\Mathworks.

  • Deleted from your project area, for example, C:\project\AutoVrtlEnv\Plugins.

Then, follow these steps.

  1. Open the project containing the scene in the Unreal Editor. You must open the project from a Simulink® model that is configured to co-simulate with the Unreal Editor.

    For more details on how to package projects, see "Packaging Projects" under Unreal Engine Documentation.

  2. Ensure the plugin content is visible in the Content Browser. Under Settings, check the Show Engine Content and Show Plugin Content check boxes.

    Image shows the Show Engine Content and Show Plugin Content check boxes are checked in View Options.

  3. In the Unreal Editor toolbar, select Settings > Project Settings to open the Project Settings window.

  4. In the left pane, in the Project section, click Packaging.

  5. In the Packaging section, set or verify the options in the table. If you do not see all these options, at the bottom of the Packaging section, click the Show Advanced expander.

    Packaging OptionEnable or Disable
    Use Pak FileEnable
    Cook everything in the project content directory (ignore list of maps below)Disable
    Cook only maps (this only affects cookall)Enable
    Create compressed cooked packagesEnable
    Exclude editor content while cookingEnable
  6. Specify the scene from the project that you want to package into an executable.

    1. In the List of maps to include in a packaged build option, click the Adds Element button .

    2. Specify the path to the scene that you want to include in the executable. By default, the Unreal Editor saves maps to the /Game/Maps folder. For example, if the /Game/Maps folder has a scene named myScene that you want to include in the executable, enter /Game/Maps/myScene.

    3. Add or remove additional scenes as needed.

  7. Specify the required asset directories to include in the executable. These directories are located in the MathWorks Interface plugin.

    Under Additional Asset Directories to Cook, click the Adds Element button to add elements and specify these directories:

    • /MathWorksSimulation/Characters

    • /MathWorksAutomotiveContent/VehiclesCommon

    • /MathWorksAutomotiveContent/Vehicles

    • /MathWorksSimulation/Weather

  8. Rebuild the lighting in your scenes. If you do not rebuild the lighting, the shadows from the light source in your executable file are incorrect and a warning about rebuilding the lighting displays during simulation. In the Unreal Editor toolbar, select Build > Build Lighting Only.

  9. (Optional) If you plan to obtain semantic segmentation data from the scene by using a Simulation 3D Camera (Automated Driving Toolbox) block, enable rendering of the stencil IDs. In the left pane, in the Engine section, click Rendering. Then, in the main window, in the Postprocessing section, set Custom Depth-Stencil Pass to Enabled with Stencil. For more details on applying stencil IDs for semantic segmentation, see Apply Labels to Unreal Scene Elements for Semantic Segmentation and Object Detection (Automated Driving Toolbox).

  10. Close the Project Settings window.

  11. Select Windows as a supported platform for your project. From the scene toolbar, select Platforms > Supported Platforms and enable Windows.

  12. From the scene toolbar, select Platforms > Windows > Package Project. Select a local folder in which to save the executable, such as to the root of the project file (for example, C:/Local/myProject).


    Packaging a project into an executable can take several minutes. The more scenes that you include in the executable, the longer the packaging takes.

    Once packaging is complete, the folder where you saved the package contains a WindowsNoEditor folder that includes the executable file. This file has the same name as the project file.


    If you repackage a project into the same folder, the new executable folder overwrites the old one.

    Suppose you package a scene that is from the myProject.uproject file and save the executable to the C:/Local/myProject folder. The editor creates a file named myProject.exe with this path:


Simulate Scene from Executable in Simulink

To improve co-simulation performance, consider configuring the Simulation 3D Scene Configuration block to co-simulate with the project executable.

  1. In the Simulation 3D Scene Configuration block of your Simulink model, set the Scene source parameter to Unreal Executable.

  2. Set the File name parameter to the name of your Unreal Editor executable file. You can either browse for the file or specify the full path to the file by using backslashes. For example:

  3. Set the Scene parameter to the name of a scene from within the executable file. For example:

  4. Run the simulation. The model simulates in the custom scene that you created.

If you are simulating a scene from a project that is not based on the AutoVtrlEnv project, then the scene simulates in full screen mode. To use the same window size as the default scenes, copy the DefaultGameUserSettings.ini file from the support package installation folder to your custom project folder. For example, copy DefaultGameUserSettings.ini from:




Then, package scenes from the project into an executable again and retry the simulation.

See Also