Expand description
Configuration
To configure your scenarios.
A scenario configuration is a cfg/ folder containing the configuration files using yaml format.
You can use an existing configuration from the examples or write your own configuration.
The cfg/ folder must be located next to the executable.
The configuration can be a single file or split in different files.
Using a single file cfg.yaml
The name of the file must be cfg.yaml, inside the configuration folder (i.e., cfg/cfg.yaml).
The configuration can be customised with the optional fields of the main Cfg structure.
Split the configuration into multiple files
Each field of the main Cfg structure can written in a separate file. It leads to the following folder
strcture:
cfg/bodies/ *.yaml: an additional folder calledbodiesin the configuration folder with as many files inside as you want for the configuration of the bodies. Each file will be a new body, given that they are defined with unique name, using theCfgBodyconfiguration.cfg/scene.yaml: a file using theCfgSceneconfiguration.cfg/simulation.yaml: a file using theCfgSimulationconfiguration.cfg/window.yaml: a file using theCfgWindowconfigurationcfg/preferences.yaml: a file using theCfgPreferencesconfiguration
General Preferences
If you install an executable of kalast, you can see that a file preferences.yaml is also shipped, next to
the executable. This serves as general preferences across your different configs. Local preferences will overwrite
general preferences.
Also
If you try to run kalast without config (i.e., no cfg/ folder with no config inside), the default config
will be used, defaulting each field of each structure.
Variant of Enums for options are in CamelCase but corresponding values in yaml config files are snake_case.
For example, see ColorMode.
What Next?
Now you should read the documentation of the different config structures: Cfg, CfgBody, CfgScene,
CfgSimulation, CfgWindow, CfgPreferences.
Structs
- Configuration
- Configuration of Body
- Configuration of Surface Mesh for Body.
- Configuration of Record for data of Body
- Configuration of the Spin of the Body.
- Manual Configuration of Position and Orientation of Body from Cartesian Coordinates
- Configuration of the Orbit of the Body
Enums
- Errors related to Kalast config.
- Configuration of the Framce Center of the Orbit of the Body.
- Configuration of Interior for Body.
- Configuration of Interior as 1D Grid
- Configuration of the Orbit Speed of the Body
- Errors related to Kalast config.
- Errors related to Kalast config.
- Errors related to Kalast config.
- Configuration of the State of the Body
- Configuration of the Initialisation of the Temperature of the Body.