Gyro configuration is done mostly through a small function at the top of gyro_user.qc
. This function is called Gyro_UserSettings()
and holds the following settings:
GYRO_AUTOTICKRATE
When this is set to 1
(or TRUE
), Gyro will attempt to run once every frame, effectively matching the user's framerate or the server's own tickrate. When set to 0
(or FALSE
), Gyro will run at it's own constant tickrate. It is recommended that you leave this at it's default value of TRUE
.
GYRO_TICKRATE
Should you choose to run Gyro at a constant tickrate, you can specify the delay between iterations here. The value is given in seconds, and should ideally fall between 0.01
and 0.05
.
GYRO_MOTIONCORRECTION
The velocity of an entity is limited by the sv_maxvelocity console variable and, because it operations on individual axes, can alter the trajectory of fast-moving projectiles. When this is set to TRUE
, Gyro will attempt to correct these abnormalities.
GYRO_POWERCONSTANT
Many of Gyro's systems (such as bouyancy) are tied directly to the set gravity. In order to maintain consistency, gravity-independent systems are scaled by the fixed power constant. Unless your mod is based around a different gravity value, you should leave this at 800
.
GYRO_FORCEDEBUG
This sets the debugging level for Gyro's force systems. A value of 0
will produce no debug output. A value of 1
will only display the most major messages, mostly pertaining to the creation and destruction of forces. Finally, a value of 2
will show the most verbose debugging information and is recommended only for the most troublesome of bugs.
GYRO_OBJECTDEBUG
Same as the above, but for physics objects. Set both to 0
to hide all of Gyro's output, including the initialisation message.
It is worth noting that none of the above settings are constants and, therefore, they can be changed during runtime. This is particularly useful when debugging, as you can effectively hide all the messages you aren't interested in.
The following settings are also non-constant values, but should not be changed during runtime:
GYRO_BOUYANCYMOD_***
These four values control the initial bouyancy multipliers of newly created physics objects. Under the default settings (0.0
, 1.0
, 1.2
and 1.4
), air has zero bouyancy, while the liquids offer bouyancy between 100-140%. You should not need to change these values as bouyancy levels can be specified on a per-object basis.
GYRO_RESISTANCEMOD_***
Just as above, but for the motion resistance subsystem.
GYRO_TURBULENCEMOD_***
Just as above, but for the turbulence subsystems.