The admin settings file contains some of the configuration settings of a simulator. It allows operations or customer support to set up the simulator as purchased by the customer.

The admin settings file is located at %LOCALAPPDATA%/CM Labs/SimulatorStore/admin.settings. The admin settings file is not installed by default on a simulator.

As long as the admin settings file is not present, factory default values hard-coded in the software or the content will be used, as described below.

Settings Entries

The file is in JSON format and supports the following entries.

Name	Description	Values	Factory Default

Name	Description	Values	Factory Default
units	the unit system to use when displaying numeric values	Metric US Customary	US Customary
language	the language to use in the user interface, if the specified string does not correspond to an available translation file, the factory default will be used.	a language_country string of the form xx_CC	en_US
learningPath	whether or not the Learning Path feature is enabled	boolean	true
tandemJoinerID	in a tandem setup, the ID of the simulator that should join to the current simulator	string	empty
screensSetupOverrides	an array of screens setup overrides to be used, one per equipment type to be overridden. The array of overrides will be examined only if the screens setup override element of the SimulatorDescription.json file is set to true.	Format: { "equipmentName": <name>, "screensSetup": <screensSetupValue> } where <name>: the Name property of an Equipment as defined in its .vxequipment definition file <screensSetupValue>: Left-Right/Top-Bottom	If no override is specified for a particular Equipment, the screens setup will be taken from the Equipment's vxequipment definition file.

File Sample

Here is a typical example of an admin.settings file:

{
   "units": "Metric",
   "language": "fr_FR",
   "learningPath": false,
   "tandemJoinerID": "CML-ID",
   "screensSetupOverrides":
   [
      {
         "equipmentName": "VX_EX_EQP_NAME",
         "screensSetup": "Left-Right"
      },
      {
         "equipmentName": "VX_BH_EQP_NAME",
         "screensSetup": "Top-Bottom"
      }
   ],
   "version": 0
}

The screen orientation “Left-Right” means that the view is setup for horizontal viewing, and does not refer to the physical orientation of the screens themselves.

An Edge screen will be horizontal while on a Advantage setup with 3 screens, the screens will go from left to right, but will be physically in a vertical position.

Vortex Studio 2023.8 Documentation

Advanced: Admin Settings file

Settings Entries

File Sample