Skip to content

Config File

Jump to bottom
Hojei Hsu edited this page Apr 28, 2024 · 13 revisions

scsd supports ini style config file. It consists of multiple sections and all sections/entries are optional. Default value will be used if not specified.

  • General: General Options
  • Rotation: How to rotate the versions
  • Log: Logging behavior for scsd
  • Notifier: Notification behavior when scsd exit
  • Target: What sorts of games should scsd target to
  • Danger Zone: Advanced options that should not be fiddled without extra care

General

  • save_dir
    • Type: path
    • Default: ./data
    • Description: Where to save the saves, logs and session files.
  • 2fa
    • Type: str
    • Default: mobile
    • Possible values: mobile, mail
    • Description: How the 2FA code should be sent.
      • mobile: If the code is sent to Steam Mobile Authenticator
      • mail: If the code is sent to Email

Rotation

  • rotation
    • Type: int
    • Default: 15
    • Description: The number of versions to keep locally. The older ones will have suffix .scsd_X append to the original file name

Log

  • log_level
    • Type: int
    • Default: 2
    • Description: How detail should scsd log
      • 0: Show Error messages only
      • 1: Show Error and Warning messages only
      • 2: Show Error, Warning and INFO messages only
      • 3: Show Error, Warning and INFO and DEBUG messages

Notifier

  • notifier:
    • Type: str
    • Default: ""
    • Description: How to notify when scsd finish or encounter error. Supported method.
      • Empty string (""): Do nothing
      • discord: Send to discord. webhook required
      • script: Send to discord. path required
  • level:
    • Type: int
    • Default: 1
    • Description: How detailed is the notification message
      • 0: Don't send notification
      • 1: Show what games are updated
      • 2: Level 1 + show which files are updated
      • 3: Level 2 + show the files updated with timestamp change
  • notify_if_no_change:
    • Type: bool
    • Default: False
    • Description: Set to true to notify even if nothing changes
  • webhook:
    • Type: str
    • Default: ""
    • Description: Required if notifier is discord. The webhook url for the channel to send to
  • path:
    • Type: str
    • Default: ""
    • Description:
      • Required if notifier is script.
      • scsd will invoke the script and pass a single string argument (file changes) to the script.
      • Please make sure the script is executable.
      • This option is supported on non-Windows OS

Target

  • mode:
    • Type: str
    • Default: ""
    • Description: What sorts of app_id should scsd download.
      • Empty string (""): Do nothing. That is, download all app_id
      • include: Only download app_id specified in list
      • exclude: Download app_id NOT specified in list
  • list:
    • Type: comma separated int
    • Default: ""
    • Description: The list to include or exclude from download
    • Example: list = 7, 12, 23

Danger Zone

  • wait_interval:
    • Type: comma separated int
    • Default: 3, 5
    • Description: Interval to wait between each web requests. The default is to wait for 3 ~ 5 (inclusive) seconds. This is to prevent Steam consider our requests as DDoS attack. Lowering this value will speedup the download process but increase the risk.

Example File

Please take a look at scsd.conf.sample

Clone this wiki locally