Skip to content

Configuration

effy reads an optional TOML configuration file once at startup. You only need to specify the settings you want to change. Missing settings use the built-in defaults. effy doesn't create, rewrite or save the configuration file automatically. To reload a configuration the restart is needed.

Config paths and precedence

effy selects one configuration file in this order:

  1. The path passed with --config <PATH>.
  2. $XDG_CONFIG_HOME/effy/effy.toml. Note: XDG_CONFIG_HOME must be an absolute path. Empty or relative values are ignored.

  3. The platform's configuration directory:

    Platform Configuration file
    Linux ~/.config/effy/effy.toml
    Windows %APPDATA%\effy\effy.toml (AppData\Roaming)
    macOS ~/Library/Application Support/effy/effy.toml

If the platform configuration directory cannot be determined, effy tries .config/effy/effy.toml under the user's home directory. If neither directory can be determined, startup fails.

Show the default config

effy --show-config

Prints the standard configuration path as a comment, followed by the built-in default TOML configuration.

The output can be used to create a configuration file:

effy --show-config > path/to/effy/config/effy.toml

Use another config file

effy --config path/to/effy/config/effy.toml input.mp4

--config replaces the standard config path for this run. Settings in that file override the built-in defaults. Theme files are loaded from the same directory as the selected config file.

Default config

# Theme: default, hacky, bloody, solarized_dark, solarized_light
theme = "default"

# Comma-separated hardware acceleration options to ignore.
# Possible values: nvidia, intel, amd, vaapi, macos
hide_hwaccel_options = ""

# LUT folder (optional) with .cube, .3dl, .csp, .dat and .m3d LUT files.
# lut_folder = "/path/to/lut/folder".

See Hardware Acceleration and LUT