Files
Sprimo/docs/CONFIG_REFERENCE.md
2026-02-15 09:40:51 +08:00

57 lines
1.4 KiB
Markdown

# Sprimo Config Reference
File location:
- Windows: `%APPDATA%/sprimo/config/config.toml`
- macOS: `~/Library/Application Support/sprimo/config/config.toml`
- Linux: `~/.config/sprimo/config/config.toml`
## Schema
```toml
[window]
x = 200.0
y = 200.0
monitor_id = ""
scale = 1.0
always_on_top = true
click_through = false
visible = true
[animation]
fps = 30
idle_timeout_ms = 3000
[sprite]
selected_pack = "default"
sprite_packs_dir = "sprite-packs"
[api]
port = 32145
auth_token = "generated-uuid-token"
[logging]
level = "info"
[controls]
hotkey_enabled = true
recovery_hotkey = "Ctrl+Alt+P"
[frontend]
backend = "bevy"
debug_overlay_visible = false
tauri_animation_slowdown_factor = 3
```
## Notes
- `auth_token` is generated on first run if config does not exist.
- `window.x`, `window.y`, `window.scale`, and flag fields are persisted after matching commands.
- `window.click_through` is deprecated and ignored at runtime; it is always forced to `false`.
- On Windows, `recovery_hotkey` now forces `visible = true` and `always_on_top = true` for recovery.
- `frontend.backend` selects runtime frontend implementation (`bevy` or `tauri`).
- `frontend.debug_overlay_visible` controls whether tauri window debug diagnostics panel is shown.
- `frontend.tauri_animation_slowdown_factor` controls tauri animation pacing multiplier.
valid range: `1..20`
effective frame interval: `(1000 / clip_fps) * factor`