Building the Unity application from the command line

Part of the Unity workflow involves building the application from a project. This runtime application is where the simulation takes place. If you are looking to establish a distributed simulator using this application, you can find detailed guidance on the following pages:

The Vortex Studio integration package for Unity includes an Editor script that offers simple and practical methods for constructing the Unity application from the Unity project through the integration. These methods are accessible via the command line by utilizing the Unity Editor -executeMethod argument.

  • Vortex.BuildScript.PerformBuild: Builds the application that is meant to be packaged and released.

  • Vortex.ScriptBuild.PerformBuildDev: Builds a development application for debugging and profiling.

    • Equivalent to checking the Development Build and Script Debugging checkboxes in the Build Settings window of the Unity Editor.

  • Vortex.BuildScript.PerformBuildDevAndWaitForDebugger: Builds a development application for debugging and profiling, but when it launches, it will wait for the developer to attach a debugger to the application. This is useful for debugging the earliest steps in the process, as soon as the application is running.

    • Equivalent to checking the Development Build, Script Debugging, and Wait for Managed Debugger checkboxes in the Build Settings window of the Unity Editor.

When invoking these methods, it's important to note that only the scenes currently enabled in the Scenes In Build list of the Unity Editor Build Settings will be incorporated into the build. Any scenes that are unchecked will be omitted.