The configuration file
The default config.yaml file in our code repository is annotated with comments describing each setting.
The following sections document the settings that can only be modified by editing the configuration file itself. The rest of settings can be edited from within Gaia Sky itself, usually using the preferences window or the control panel. A double colon
:: in the list below indicates nested settings.
program::minimap::inWindow– enables the rendering of the mini-map in a window.
program::net– this group contains the configuration of the REST server, as well as the master-slave infrastructure. Find more information in the connect instances section.
program::scriptsLocation– default location of script files in the file system.
program::ui::animationMs– duration of UI animations in Gaia Sky, in milliseconds.
program::url– contains the URLs for the version check (Codeberg API), the data repository mirror and the data descriptor file.
program::net– contains the configuration of the REST API (port), and the master/slave instances. See here for more information.
program::offlineMode– Gaia Sky won’t attempt any HTTP connection to the internet in this mode. This means that the data descriptor file containing the information on server datasets can’t be fetched. You need to download the desired datasets manually and extract them in your data folder. More information can be found in our Gaia Sky datasets repository.
program::safeMode– this is activated automatically whenever OpenGL incompatibilities are detected at startup. On macOS, this is on by default. Safe mode disables ‘advanced’ graphics features like 32-bit float buffers.
controls::gamepad::blacklist– a list of controller names to blacklist. You can find out the controller names recognized by Gaia Sky in the controls tab of the preferences window.
graphics::useSRGB– use the sRGB color space as a frame buffer format. Only supported by OpenGL 3.2 and above. If this is activated, the internal format
GL_SRGB8_ALPHA8is used. Only available when safe graphics mode is not active.
graphics::backBufferScale– fixed scaling factor for the backbuffer. Increase this to improve image fidelity at the expense of performance. If dynamic resolution (see this) is enabled, this setting is ignored. This setting is exposed to the UI as “Dynamic resolution” in the experimental graphics settings section.
data::skybloxLocation– contains the location of the default skybox used for reflections.
scene::fadeMs– how long does the fade transition last when changing the visibility of objects or types, in milliseconds.
scene::star::textureIndex– the index of the texture used for stars. Star texture files are PNG files provided by the
default-datapackage, and are of the form
scene::star::group::numLabel– the maximum number of labels rendered by any star set.
scene::octree::maxStars– the maximum number of stars loaded at any single time for LOD catalogs.
scene::label::number– controls the global number of stars in the scene by lowering the label solid angle threshold. Increase to get more labels, decrease to get less labels.
scene::initialization– contains the
lazyMeshproperties, which enable the lazy initialization of textures and meshes respectively.
postprocess::bloom::fboScale– frame buffer scale factor (applied to the current viewport dimensions) to determine the frame buffer size to render the bloom effect.
postprocess::lensFlare::type– choose the type of lens flare shader to use. Possible options are SIMPLE (a simple, nice-looking lens flare), COMPLEX (uses a complex and more demanding lens flare shader), and PSEUDO (uses a pseudo lens flare shader, described [here](https://john-chapman.github.io/2017/11/05/pseudo-lens-flare.html)).
postprocess::lensFlare::numGhosts– number of ghost artifacts of the pseudo lens flare shader.
postprocess::lensFlare::haloWidth– halo width of the pseudo lens flare shader.
postprocess::lensFlare::blurPasses– number of blur passes for the pseudo lens flare shader.
postprocess::lensFlare::flareSaturation– saturation value for the flare in the pseudo lens flare shader.
postprocess::lensFlare::bias– bias value for the original image in the pseudo lens flare shader.
postprocess::lensFlare::texLensColor– color lookup texture path for the pseudo lens flare shader.
postprocess::lensFlare::texLensDirt– dirt texture path for all lens flare effects.
postprocess::lensFlare::texLensStarburst– starburst texture path for all lens flare effects.
postprocess::lensFlare::fboScale– scale of the frame buffer object to render the pseudo lens flare effect.
postprocess::lightGlow::samples– number of samples to use to detect the brightness of the underlying star in the light glow effect/shader.
postprocess::warpingMesh::pfmFile– absolute path to a PFM (portable float map)
.pfmfile that contains the warping mesh to apply. For more info, see Mesh warping.
proxy– configure an HTTP/HTTPS proxy. Find the full documentation to configure a proxy in the proxy configuration section.