Custom Build
Last updated
Was this helpful?
Last updated
Was this helpful?
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 studios@polygonflow.io
We usually invite companies on a shared Slack channel in which we can provide them live guidance and speak directly with their artists for feedback requests. Please reach out!
With that out of the way, let's dig in.
First, you'll need to grab the Dash source right here:
This will download a 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.
GraphNUnrealPlugin: This directory contains the C++ code necessary for integrating Dash into your custom engine build.
init_unreal.py: Should you opt not to install Dash on every artist's machine, this developer file serves as the entry point to initiate the Python portion of the plugin.
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”
The plugin exposes some functionalities to the python interpreter, and you can make unreal generate the python stubs for you, so you can load them in our IDE.
Open Unreal Engine and activate the plugin. It will activate Python Script Plugin and Editor scripting utilities plugins
Go to project settings and enable developer mode
Restart the editor.
Check PROJECT_ROOT/Intermediate/PythonStub/unreal.py
Add this file to your IDE to have the auto complete with the exported functions
Open the solution in Visual Studio or Rider and build it from there Find more information at the .
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: