README.md

Search patterns

1. Install python 3.10

2. Install poetry:

   pip install poetry

3. Run search:

   poetry run search path="C:/path/to/Dwarf Fortress/Dwarf Fortress.exe"

   or:

   uv run search path="C:/path/to/Dwarf Fortress/Dwarf Fortress.exe"

   (uv >= 0.4.23)

Alternatively, you can add a yaml config in the root of the project instead of using the CLI options:

.config.yaml:

path: "C:/path/to/Dwarf Fortress/Dwarf Fortress.exe"

And then run the utility just with poetry run search (or uv run search).

If version_name configuration is set, the offsets will be written into a ready to use toml file.