How to Debug Vortex Launcher and Simulator
- Marc Lievin
Analytics
Accessing the Debug pages
The local admin can access the debug pages in the Simulator. Pressing Ctrl-D makes the Debug pages appear along with a Debug button in the top bar.
Pressing the Debug button toggles the Debug pages on and off. Pressing Ctrl-D again removes the Debug pages and the Debug button.
Some of the pages are available on the Launcher and others on the Simulators
For advanced use cases, it is also possible to access debug pages using any user account(Guest, trainee or local admin). To do so, define the “VORTEX_OVERRIDE_DEBUG_ACCESS“ environment variable to “1” before starting Vortex Launcher.
Vortex Launcher
The pages available on the Vortex Launcher depend on the setup files of the Launcher. By default there is
Vortex Simulator
The Vortex Simulator is the application that is running after the equipment was selected. The available debug pages depend on the pages added to the setup files in the hardware configuration packages installed. The debug pages are extension console pages, categorized as Debug. Usually, the pages found could include
Accessing the Simulator Description File
On a simulator, the SimulatorDescription.json installed at %LOCALAPPDATA%/CM Labs/SimulatorStore/SimulatorDescription.json will be used to know the correct hardware configuration to use. The installed projects need to contain vxsimulator files in the content/resources/simulators directory.
Note that the SimulatorDescription.json file needs to be present on every computer of the simulator for most features to work.
See Simulator Description File for Simulator Options Configuration for more details on the SimulatorDescription file.