Skip to content
This repository

Flare follows the XDG Base Directory Specification.

When Flare is launched, three path variables are set and used throughout runtime.

  • PATH_CONF contains the path for user-specific config files (e.g. settings.txt, keybindings.txt)
  • PATH_USER contains the path for user-specific data (e.g. save files)
  • PATH_DATA contains all the static game data (e.g. the mods folder)

PATH_CONF

If the environment variable $XDG_CONFIG_HOME is set, config files are written to $XDG_CONFIG_HOME/flare/

If the environment variable $HOME is set, config files are written to $HOME/.config/flare/

Otherwise, ./config/ is used

If these folders don't yet exist, they are created (700 permissions) and the default config file is written.

PATH_USER

If the environment variable $XDG_DATA_HOME is set, save files are written to $XDG_DATA_HOME/flare/

If the environment variable $HOME is set, save files are written to $HOME/.local/share/flare/

Otherwise, ./saves/ is used

If these folders don't yet exist, they are created (700 permissions). Save files will be written there when a new game is created.

PATH_DATA

If the environment variable $XDG_DATA_DIRS is set, look through those directories (separated by a colon) for a "flare" folder.

If /usr/local/share/flare/ exists, use it

If /usr/share/flare/ exists, use it

If /usr/local/share/games/flare/ exists, use it

If /usr/share/games/flare/ exists, use it

Otherwise, ./ is used

Something went wrong with that request. Please try again.