Docs: local Sacred Gold install required, no hard-coded game path

README explains --game-dir and the stored GameDir; the VS Code launch
uses the stored path and builds through build.ps1.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
khallaandClaude Opus 5.5 committed 2026-10-20 00:14:36 +02:00
1 parent 6c467e22c4
commit 5df7efc198
4 files changed
+31 -11

No files matched your search

+15 -2
View File
@@ -41,11 +41,24 @@ the CMake presets.
## Running
The game is not part of this repository. You need a local installation of
Sacred Gold 2.28 with the `sacred.exe` listed under [Supported build](#supported-build)
(e.g. the Steam or GOG release), and you tell the launcher its folder once:
```powershell
build\x86-debug\sacredK.exe --game-dir "D:\Gaming\Sacred Gold" # first run; remembered in sacredK.ini
build\x86-debug\sacredK.exe log # later runs; extra args go to the game
build\x86-debug\sacredK.exe --game-dir "<Sacred Gold folder>" # first run; remembered in sacredK.ini
build\x86-debug\sacredK.exe log # later runs; extra args go to the game
```
The folder is stored as `[paths] GameDir` in `sacredK.ini` next to the
launcher (one per build preset, not tracked by git). Without it, the launcher
looks for `sacred.exe` in its own folder and otherwise asks for `--game-dir`.
The VS Code launch configuration relies on this stored path too.
Save games and the game's `Settings.cfg` live in `Documents\Sacred\save` and
`Documents\Sacred\config`; on the first start they are copied there from the
game folder (see `docs/user-folders.md`).
`sacredK.log` (next to the DLL) records what was hooked plus every message the
game sends to its internal logger, even when the game's own logging is off.