-
Notifications
You must be signed in to change notification settings - Fork 0
How To Start a Sim
The Fundamentals → How To Start a Sim |
---|
Written by Connor Jakubik
This guide will take you through the ways that you can start a Space Teams sim. Space Teams has many varied usage methods which vary in the amount of navigating menus or scripting command line arguments required.
This is the typical way users will be interacting with the application when not doing automated sim-running of some sort.
-
Demos
page from the main menu - Select a demo
Start Demo
-
Sim
page from the main menu -
Singleuser
option on the top - Select a sim config
Confirm
-
Design
page from the main menu -
Sim Config Editor
option Start Tool
Multiuser sims are currently inoperative due to work in progress changes to our backend servers
Open the SpaceCRAFT app through SpaceCRAFT_VR.bat
. From there, you are presented with the normal flat screen UI. Interact with this by pointing with your VR controller and clicking with the trigger.
This skips the menus and starts the Unreal app directly into a simulation, with some options.
- From the
/SpaceCRAFT
directory -
SpaceCRAFT.exe --sim=packages/path/to/your/sim.json
- The directory can also start with
Core/packages/......
to correspond to theCompute_Server/packages
folder in the STPro install directory, orLocal/......
to correspond to theAppData/Local/SimDynamX/STPro/Assets
folder.
- The directory can also start with
Optional arguments include:
-
-vr
: Start in VR mode (can also be done by itself to open the menu in VR) -
-raytracing
: Run the sim with higher-fidelity raytraced shadows (as opposed to Cascaded Shadowmaps)
Work in progress.
- From the
/Compute_Server
directory -
run_Server.exe --sim=packages/path/to/your/sim.json
- The directory can also start with
Core/packages/......
to correspond to theCompute_Server/packages
folder in the STPro install directory, orLocal/......
to correspond to theAppData/Local/SimDynamX/STPro/Assets
folder.
- The directory can also start with
- OR (v0.20.0+)
run_Server.exe -i
for Interactive Mode, then follow instructions to find the sim config you want to start
Optional arguments include:
-
-noCatchSystemExceptions
: Instead of wrapping C++ Systemload()
,init()
,update()
, etc functions in try/catch blocks that will route exceptions to the logger, this option will leave the exceptions unhandled. If your debugger is attached to therun_Server
process, you will be able to break-and-debug on the unhandled exceptions. -
-det
: Run your sim using Deterministic fast-as-possible scheduling. This means your sim, which would normally run on several async threads, will run with a deterministic order and timing of events on a single thread, as fast as possible while still hitting all of the update functions. Typically, no code changes are required. Python Systems (and other clients like the SpaceCRAFT UE client) are still on separate processes and may have nondeterministic effects on the sim; we don't yet have some sort of lock-step synchronization functionality.
Work in progress.
-
sc.standalone_sim("packages/path/to/your/sim.json")
- The directory can also start with
Core/packages/......
to correspond to theCompute_Server/packages
folder in the STPro install directory, orLocal/......
to correspond to theAppData/Local/SimDynamX/STPro/Assets
folder.
- The directory can also start with
Work in progress.