Simulation configuration file (cfg_simulation)
- Last UpdatedDec 04, 2023
- 4 minute read
The cfg_simulation.xml file contains configuration settings that relate to settings for a particular simulation.
simulation
The simulation parameters of the configuration file.
|
Parameter |
Type |
Description |
|---|---|---|
|
simulation |
group |
This section enables customization of the simulation and definition of the involved settings. It is also used to customize local instances in terms of avatar characteristics and interactions. |
|
playersnumber |
sint |
Number of total virtual field operators in the [1 6] range. |
|
bridgeexists |
sbool |
Specifies whether the simulation includes an XR Bridge instance. True or False. |
|
instructorExists |
sbool |
Specifies whether the simulation includes an XR Instructor instance. True or False. |
|
player0 |
group |
For configuring the first field operator (player0). |
|
position |
svec3 |
Starting position. |
|
orientation |
svec2 |
Starting orientation. |
|
mode |
sstring |
Simulation role. Values: master, slave, standalone. |
|
player1 |
group |
For configuring the second field operator (player1). |
|
position |
svec3 |
Starting position. |
|
orientation |
svec2 |
Starting orientation. |
|
mode |
sstring |
Simulation role. Values: master, slave, standalone. |
|
player2 |
group |
For configuring the third field operator (player2). |
|
position |
svec3 |
Starting position. |
|
orientation |
svec2 |
Starting orientation. |
|
mode |
sstring |
Simulation role. Values: master, slave, standalone. |
|
player3 |
group |
For configuring the fourth field operator (player3). |
|
position |
svec3 |
Starting position. |
|
orientation |
svec2 |
Starting orientation. |
|
mode |
sstring |
Simulation role. Values: master, slave, standalone. |
|
player4 |
group |
For configuring the fifth field operator (player4). |
|
position |
svec3 |
Starting position. |
|
orientation |
svec2 |
Starting orientation. |
|
mode |
sstring |
Simulation role. Values: master, slave, standalone. |
|
player5 |
group |
For configuring the sixth field operator (player5). |
|
position |
svec3 |
Starting position. |
|
orientation |
svec2 |
Starting orientation. |
|
mode |
sstring |
Simulation role. Values: master, slave, standalone. |
|
instructor |
group |
This section enables configuration of the XR Instructor instance. |
|
mode |
sstring |
Simulation role. Values: master, slave, standalone. |
avatar
The avatar parameters of the configuration file.
|
Parameter |
Type |
Description |
|---|---|---|
|
avatar |
sstring |
Type of avatar to use. Custom avatar requires additional work to be set up. Values are: SHADERGEN, CUSTOM. |
|
rotationSpeed |
sfloat |
Avatar rotation speed. |
|
walkSpeed |
sfloat |
Avatar walk speed. |
|
walkHeight |
sfloat |
Avatar firsr person camera walk height. |
|
walkFov |
sfloat |
Avatar first person camera walk FOV. |
|
runSpeed |
sfloat |
Avatar run speed. |
|
runHeight |
sfloat |
Avatar first person camera run height. |
|
runFov |
sfloat |
Avatar first person camera run FOV. |
|
crouchSpeed |
sfloat |
Avatar crouch speed. |
|
crouchHeight |
sfloat |
Avatar first person camera crouch height. |
|
crouchFov |
sfloat |
Avatar first person camera crouch FOV. |
|
flySpeed |
sfloat |
Avatar fly speed. |
|
autostart |
sbool |
Enables automatic simulation to start when a master node connects. This should be set to true only when performing a self learning with internal scenario selection. In all other cases, it should be set to false. |
|
playerState |
sstring |
Initial player state. Values are: ready, wait, live. |
interactionselector
The interactionselector parameters of the configuration file.
|
Parameter |
Type |
Description |
|---|---|---|
|
interactionSelector |
group |
For customizing the interaction selector. |
|
silhouetteColor |
Selectable item silhouette color. |
|
|
silhouetteDebugColor |
Silhouette used for debug items. |
|
|
avatarPickDistance |
Maximum distance for selecting an item and operating it. |
|
|
highlightDistance |
Maximum distance for detecting an item as selectable. |
|
|
labelViewer |
group |
Sets up the label manager behavior. |
|
mode |
sstring |
Label mode. Values are: labelLeft, labelOver, labelCenter, labelZoom, labelOld, label3d. |
|
showStatusBar |
sbool |
Show status bar during simulation. |
camera
The camera parameters of the configuration file.
|
Parameter |
Type |
Description |
|---|---|---|
|
cameraMode |
group |
Defines the field operator view. |
|
startup |
sstring |
Startup cameraMode. Values are: fps, behind. |
|
fpsEnabled |
sbool |
Enables fps mode. |
|
behindEnabled |
sbool |
Enables behind mode. |
|
overEnabled |
sbool |
Enables over mode. |
|
overDistance |
sfloat |
Fly camera initial vertical offset. |
|
overPhysics |
If set to true, avatar fly camera will collide with cmesh_fly (if exists) or with cmesh_static (if cmesh_fly does not exists). Otherwise, there's no collision. |
|
|
overRay |
sfloat |
Defines camera collision distance in fly mode. Used when overDistance is set to true. |
|
behindDistance |
sfloat |
Avatar third person camera behind distance. |
|
near |
sfloat |
Camera near cutting plane. |
|
far |
sfloat |
Camera far cutting plane. |
|
convergenceType |
sstring |
Camera convergence type, used when rendering in stereo. Values are: parallel, toeIn, offAxis. |
|
convergence |
sfloat |
Camera convergence, used when rendering in stereo. |
|
separation |
sfloat |
Camera separation, used when rendering in stereo. |
login
The login parameters of the configuration file.
|
Parameter |
Type |
Description |
|---|---|---|
|
login |
group |
Enables skipping the sim-setup steps (login, scenario selection, dpi selection). These parameters are usually overriden by custom.xml or other files set outside of the gamedata folder. |
|
overPhysics |
sbool |
Enables login and scenario selection skip. |
|
userName |
sstring |
Full name of user. |
|
userID |
sstring |
User id of the user. This parameter is often used to send performance data to external receivers. |
|
simsetupStartKey |
sstring |
Identifier of the scenario to start. |