Customizing Vortex Unity integration

Owned by Marc Lievin
Aug 20, 2024
2 min read

When using the Unity Editor with Vortex, it is important to configure Vortex properly for all the features you want to use. Just like any other Vortex applications, the Unity Editor using the Vortex integration package is configured with a Setup file (more information at https://vortexstudio.atlassian.net/wiki/spaces/VSD2407/pages/3690447898).

The integration package in Unity contains two default setup files for the Unity Editor: one for Edit mode and one for Play mode. Both contain all the basic features for a standalone Vortex simulator, and the Play mode Setup file also contains standard Vortex UI to be able to inspect and control the simulation.

Vortex Settings

From the Vortex menu in Unity Editor, Settings gives access to several customization options for using Vortex in the Unity.

All those settings are optional and are persisted in the StreamingAssets folder.

Edit mode setup document

The custom setup file that will be used in the Unity Editor at Edit time. Press the Create Setup button to create a new one and edit it.

Play mode setup document

The custom setup file that will be used in the Unity Editor at Play time. Press the Create Setup button to create a new one and edit it.

This Setup file will also be used when the Unity executable is built. It it stored in the StreamingAssets folder.

Data provider’s path

The custom path where application data is stored (default is empty)

Optional Log file Path

The custom full path of the Vortex log file (default is in %TEMP%)

Vortex toolkit path

The custom path to the Vortex libraries. By default, the Vortex path is automatically found from the installed packages.

See how to use a specific Vortex Studio installation for more information.

Â