CLI Arguments

All scalar config fields can be overridden via CLI. CLI arguments take priority over config.json; array settings (such as network allow/deny lists and normalized mask points) are configured in the file.

Format

Windows

dearscenario-player.exe --key <value>
dearscenario-player.exe --boolean-flag
dearscenario-player.exe --no-boolean-flag

Raspberry Pi

dearscenario-player --key <value>
dearscenario-player --boolean-flag
dearscenario-player --no-boolean-flag

Special options

Argument	Description
`--help`, `-h`	Show help and exit.
`--open-file <path>`	Play this file from 0s without looping. Not saved to config.
`--reset-ui`	Reset debug panel layout (delete `imgui.ini` under the user pref directory) and start normally. Paths: Windows `%APPDATA%\\Diria\\DearScenario Player\\`; macOS `~/Library/Application Support/Diria/DearScenario Player/`; Linux `~/.local/share/Diria/DearScenario Player/`.
`--crash-test`	Intentionally crash after startup logging for dump testing.
`--dump-api-spec <path>`	Export API spec JSON to a file and exit (no runtime started).
`--dump-openapi <path>`	Export OpenAPI 3.1 JSON to a file and exit (no runtime started).

Common options

Network

--base-port 18290
--enable-osc / --no-enable-osc
--listen-address 0.0.0.0
--advertise-address auto

Window

--fullscreen / --no-fullscreen
--fullscreen-mode exclusive
--screen-index 0
--fullscreen-width 1920
--fullscreen-height 1080
--always-on-top / --no-always-on-top

Decode

--hwdec-mode auto

Maintenance

--maintenance
--alias "Hall_A"
--show-console

--maintenance selects the process-local Maintenance mode. It does not persist a developer flag in config.json; the ordinary executable entry always starts Normal mode.

--show-console is also process-local and is not saved to config.json.

Control

--media-root "./assets"
--load-timeout 30

Idle Screen

--idle-image "C:\\assets\\idle.png"
--idle-fill-mode fit

Audio

--audio-output-device auto

Projection Mask

--mask-enabled / --no-mask-enabled
--mask-invert / --no-mask-invert
--mask-feather 2.0

Examples

Windows

dearscenario-player.exe --maintenance --fullscreen --screen-index 1
dearscenario-player.exe --config "C:\DearScenario Player\config.json" --base-port 9000
dearscenario-player.exe --no-fullscreen --open-file "D:\media\main_loop.mp4"

Raspberry Pi

dearscenario-player --maintenance --fullscreen --screen-index 0
dearscenario-player --config /etc/dearscenario-player/config.json --base-port 9000
dearscenario-player --no-fullscreen --open-file /home/pi/media/main_loop.mp4

CLI Arguments

On this page