Skip to content

Configuration

SISR can be configured via:

  1. CLI flags
    See CLI Reference
  2. Environment variables
  3. Config files (TOML/YAML/JSON)

Configuration merging

SISR merges defaults + any discovered config files + your explicit --config file + CLI overrides
(in that order)

Config file discovery

SISR looks for these names and extensions:

  • Names: SISR, config
  • Extensions: .toml, .yaml, .yml, .json

Search locations:

  • Your platform config directory
    • Windows: %APPDATA%\SISR\config (example: C:\Users\<UserName>\AppData\Roaming\SISR\config)
    • Linux: $XDG_CONFIG_HOME/sisr (or ~/.config/sisr)
  • The directory next to the SISR executable

You can also explicitly provide a config file path via --config <FILE>.

Discovery order and precedence

When multiple sources provide the same configuration option, the latest one in the following is picked:

  1. Defaults
  2. Discovered config files (in this exact order):
    1. In the platform config dir:
    2. Next to the SISR executable:
  3. Your explicit --config <FILE> (if provided)
  4. CLI flags and environment variables

Common options

Option Description Default
--c file
--config file
 specify config file
-w
--window-create [true|false]
 Create/Show window at launch false
-f
--window-fullscreen [true|false]
 Create a transparent, borderless,always on top, overlay window.
used as an overlay-target
Window is fully transparent and click-through 		true
-wcd
--window-continous-draw [true|false]
 Continously update/draw to the window.
May be used when steam oerlay detection fails or other issues with the steam overlay occur 		true
--viiper-address <hostname:port> VIIPER API-server address
Can be specified if VIIPER is run manually, or on another machine 		localhost:3242
--kbm
--keyboard-mouse-emulation
 Emulate/Forward Keyboard and Mouse inputs
Can only be used if the VIIPER-server is running on a different machine 		false

Full example (default) configuration

All values are optional.

🪟 C:\Users\<UserName>\AppData\Roaming\SISR\config\SISR.toml
🐧 $XDG_CONFIG_HOME/sisr/SISR.toml

# Windows only: show console window
# On other platforms this key is ignored
console = false

# Enable/disable system tray icon
tray = true

# VIIPER API server address
viiper_address = "localhost:3242"

# Enable keyboard/mouse emulation.
# Will only work if the specified VIIPER server does not run on localhost
kbm_emulation = false

[window]
# Create/Show window at launch
create = false

# Create a transparent fullscreen (borderless) overlay window
fullscreen = true

# Enable continuous redraw
# May be used when steam oerlay detection fails or other issues with the steam overlay occur
# may increase CPU/GPU usage
continous_draw = false

[log]
# Logging level
# Allowed: "error", "warn", "info", "debug", "trace"
level = "info"

# write logs to a file
# Default (Linux): ~/.local/share/sisr/SISR.log  (or $XDG_DATA_HOME/sisr/SISR.log)
path = "C:/Users/<UserName>/AppData/Roaming/SISR/data/SISR.log"

# logging level for the file only
# If omitted, SISR uses `log.level`
file_level = "info"

[steam]
# Disable Steam CEF remote debugging
cef_debug_disable = false

# Time to wait for Steam to launch (seconds)
steam_launch_timeout_secs = 1

# explicit Steam path, normally auto inferred to something like:
steam_path = "C:/Program Files (x86)/Steam"