1 of 1

Custom Build

In this page, we'll go through the process of installing Dash on a custom UE5 build. Few things to keep in mind:

Dash is only compatible with UE5.1 and above.
In most cases, the process should be fairly straightforward, but if your custom UE5 build has been drastically changed from the base engine source, there might be some hiccups, and we recommend that you reach out to [email protected]
We usually invite companies to a shared Slack channel in which we can provide them live guidance and speak directly with their artists for feedback requests. Please reach out!
In order to turn off crash reporting, analytics, AI features, etc, you can set certain Environment Variables. More info on this topic further down.

With that out of the way, let's dig in.

There are two build methods, the first being Plugin Build and the other being Source Build. The files for both are located in this Google Drive: , and you can choose your preferred build method by checking the different instructions below.

Build Methods:

Option 1: Plugin Build Instructions

This is the most straightforward deployment mode, as it’s a normal Unreal Engine plugin structure. can be applied normally.

Start by opening the Plugin Build folder in the and then opening the folder corresponding to the Dash version you want to install. Here you will find one zip for each UE version we support, so you only have to download the zip for your specific UE version.

Once the zip has been downloaded and extracted, the Dash folder can be placed under PROJECT_ROOT/Plugins or ENGINE_ROOT/Engine/Plugins as described in the .

Option 2: Source Build Instructions

For this build option, start by opening the Source Build folder in the and then downloading the zip for the Dash version you wish to install.

This ZIP file, which contains:

Dash: This folder holds the files copied from the installer. It allows you to distribute the plugin without installation, through version control or a shared folder.

Exclusions from Version Control

Possible files to exclude from version/source control for both build types:

Plugins/UnrealEngineContext/Imports/thirdparty (~2 GB) - This folder will be created and populated per user machine and will contain Python packages
Modules/GN/ContentLibrary/Backends/IESLibrary/IesLibraryContents (~28 MB) - This folder will be extracted from

Dash Environment Variables

Dash Environment Variables Instructions

By setting certain Environment Variables, you can control whether certain features and options are available in Dash. The use of "1", "yes", or"true" all respond to true.

DASH_CRASH_REPORT_ENABLED

FAQ

Permission Denied / read-only / write proteced file - Revision Control Issue

If you see an error regarding permission denied or read/write, for example, regarding the metadata.json file, you can try two things:

Turn off the automatic write protection on the Documents folder that Windows Defender adds in Windows 11. It is a "Protected folder"

You can mark the metadata.json or any other Dash files under revision control as always writable through Perforce, etc, and then do the installation process again from the beginning.

Do we need to compile the plugin on every machine?

No. You can distribute the pre-built C++ plugin on every machine using the same engine version you built against.

Do we need to install the plugin on every artist machine?

In order to run, Dash will need 2 components:

The Unreal C++ plugin
The Dash Python plugin

You can install the plugin on every artist machine, or distribute it directly with your version control, alongside the custom built C++ plugin.

What are the dependencies of the C++ plugin?

Following a list of the dependencies of the C++ layer:

Memory lib from microsoft (unreal uses it too)

mimalloc.lib

Dash Dependencies (Internal)

What are the dependencies of Dash Python plugin?

Dash relies on a series of internal and third party libraries. The following list might change, but at the moment of writing these are the third party libraries used:

abseil
eigen

Will I need to recompile the plugin each new release?

Yes. If you are using a custom Unreal version, you will be in charge of recompiling the C++ plugin and redistribute the matching Dash Python plugin alongside with it. Once you already have the structure in place, it should be as simple as regenerate the project and build. Make sure to update also the init_unreal.py as it might change between releases.

When a new version of Dash is available, you will get a notification directly in Dash, and once you get that you will find the latest ZIP to download here always:

When compiling the C++ plugin I get some warnings, how can I solve it?

Dash is constantly evolving, and our top priority is to give artists and studios constant updates and new tools to improve their workflow. This rapid pace of development will sometimes leave behind some compile warnings which we are aware of, and are not critical. They might get fixed while moving forward, but if you have a zero warning policy unfortunately you might have to address the ones you get.

How many Enterprise Seats do I need?

You only need seats for those artists who want access to the tools and the ability to adjust parameters. You do not need licenses for Build Machines either.

Resource Error - Unable to copy files in your project

If you are using Perforce or another Version Control Software and, upon opening Dash, see our resource update popup and it fails by showing you a Resource Error, here is what you need to do:

If you are on Dash 1.9.2 or higher, move to step 5
Close UE,

Custom Build

In this page, we'll go through the process of installing Dash on a custom UE5 build. Few things to keep in mind:

Dash is only compatible with UE5.1 and above.
In most cases, the process should be fairly straightforward, but if your custom UE5 build has been drastically changed from the base engine source, there might be some hiccups, and we recommend that you reach out to [email protected]
We usually invite companies to a shared Slack channel in which we can provide them live guidance and speak directly with their artists for feedback requests. Please reach out!
In order to turn off crash reporting, analytics, AI features, etc, you can set certain Environment Variables. More info on this topic further down.

With that out of the way, let's dig in.

Build Methods:

Option 1: Plugin Build Instructions

This is the most straightforward deployment mode, as it’s a normal Unreal Engine plugin structure. can be applied normally.

Once the zip has been downloaded and extracted, the Dash folder can be placed under PROJECT_ROOT/Plugins or ENGINE_ROOT/Engine/Plugins as described in the .

Option 2: Source Build Instructions

For this build option, start by opening the Source Build folder in the and then downloading the zip for the Dash version you wish to install.

This ZIP file, which contains:

Dash: This folder holds the files copied from the installer. It allows you to distribute the plugin without installation, through version control or a shared folder.

Exclusions from Version Control

Possible files to exclude from version/source control for both build types:

Plugins/UnrealEngineContext/Imports/thirdparty (~2 GB) - This folder will be created and populated per user machine and will contain Python packages
Modules/GN/ContentLibrary/Backends/IESLibrary/IesLibraryContents (~28 MB) - This folder will be extracted from

Dash Environment Variables

Dash Environment Variables Instructions

By setting certain Environment Variables, you can control whether certain features and options are available in Dash. The use of "1", "yes", or"true" all respond to true.

DASH_CRASH_REPORT_ENABLED

FAQ

Permission Denied / read-only / write proteced file - Revision Control Issue

If you see an error regarding permission denied or read/write, for example, regarding the metadata.json file, you can try two things:

Turn off the automatic write protection on the Documents folder that Windows Defender adds in Windows 11. It is a "Protected folder"

You can mark the metadata.json or any other Dash files under revision control as always writable through Perforce, etc, and then do the installation process again from the beginning.

Do we need to compile the plugin on every machine?

No. You can distribute the pre-built C++ plugin on every machine using the same engine version you built against.

Do we need to install the plugin on every artist machine?

In order to run, Dash will need 2 components:

The Unreal C++ plugin
The Dash Python plugin

You can install the plugin on every artist machine, or distribute it directly with your version control, alongside the custom built C++ plugin.

What are the dependencies of the C++ plugin?

Following a list of the dependencies of the C++ layer:

Memory lib from microsoft (unreal uses it too)

mimalloc.lib

Dash Dependencies (Internal)

What are the dependencies of Dash Python plugin?

Dash relies on a series of internal and third party libraries. The following list might change, but at the moment of writing these are the third party libraries used:

abseil
eigen

Will I need to recompile the plugin each new release?

When a new version of Dash is available, you will get a notification directly in Dash, and once you get that you will find the latest ZIP to download here always:

When compiling the C++ plugin I get some warnings, how can I solve it?

How many Enterprise Seats do I need?

You only need seats for those artists who want access to the tools and the ability to adjust parameters. You do not need licenses for Build Machines either.

Resource Error - Unable to copy files in your project

If you are using Perforce or another Version Control Software and, upon opening Dash, see our resource update popup and it fails by showing you a Resource Error, here is what you need to do:

If you are on Dash 1.9.2 or higher, move to step 5
Close UE,

Create a new Unreal C++ project
Place the plugin into the Plugins folder of the project (create Plugin folder if it doesn’t exist yet). Result must be Plugins\\GraphNUnrealPlugin
Copy the init_unreal.py shipped in the ZIP inside your project Plugins/GraphNUnrealPlugin/Content/Python to allow the plugin to see Dash and its libraries, or you will get errors like ModuleNotFoundError: No module named 'GN'
Edit the path at the end ofinit_unreal.py file, with the location where you placed your Dash folder if you want to distribute the plugin, or with the installation directory, if you are using the installer.
Generate the visual studio project by right clicking in explorer on the .uproject file and selecting “Generate Visual Studio project files”

Custom Build

Build Methods:

Exclusions from Version Control

Dash Environment Variables

DASH_CRASH_REPORT_ENABLED

FAQ

Custom Build

Build Methods:

Exclusions from Version Control

Dash Environment Variables

DASH_CRASH_REPORT_ENABLED

FAQ

Disk space consumption

Compilation

Uninstallation

Use From Python

DASH_UPDATE_CHECK_ENABLED

DASH_ANALYTICS_ENABLED

DASH_REGISTER_PREFERENCES_FOR_ANALYTICS

DASH_OPEN_AI_ENABLED

DASH_REGISTER_PREFERENCES_FOR_OPEN_AI