Skip to content

Commit

Permalink
tighten up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
myk002 committed Nov 28, 2024
1 parent e1ffa61 commit 1f18076
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions docs/Core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -334,16 +334,13 @@ used regardless of whether you run Dwarf Fortress from its own app or DFHack's.
counted towards your hours, see the DFHack stub launcher ``--nowait`` option
below.

- ``--skip-size-check``: DFHack normally compares its idea of the sizes of a
handful of key game structures against the sizes reported by DF itself in
DF's global "cheat sheet", and shuts down if a discrepancy is detected.
This is intended to reduce the risk of misalignments in these structures leading
to crashes or other misbehavior. This option bypasses this check.
This option should normally only be used to facilitate DFHack development.
This option will **not** enable DFHack to be used usefully with a version of DF
to which DFHack has not been aligned. Without properly aligned structures,
DFHack is mostly useless and most operations will either fail
or cause DF to crash or otherwise misoperate.
- ``--skip-size-check``: DFHack normally verifies the sizes of important game
on startup and shuts down if a discrepancy is detected. This is intended to
reduce the risk of misalignments in these structures leading to crashes or
other misbehavior. This option bypasses the check. This option should
normally only be used to facilitate DFHack development. This option will
**not** enable DFHack to be used usefully with a version of DF with which
DFHack has not been aligned.

Options passed to the DFHack Steam stub launcher
------------------------------------------------
Expand Down

0 comments on commit 1f18076

Please sign in to comment.