remove now-unused binpatches

CMakeLists.txt

@@ -451,7 +451,6 @@ if(INSTALL_DATA_FILES)
     install(FILES LICENSE.rst DESTINATION ${DFHACK_USERDOC_DESTINATION})
     install(FILES docs/changelog-placeholder.txt DESTINATION ${DFHACK_USERDOC_DESTINATION} RENAME changelog.txt)
     install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/depends/luacov/src/luacov/ DESTINATION ${DFHACK_DATA_DESTINATION}/lua/luacov)
-    install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/patches/ DESTINATION ${DFHACK_DATA_DESTINATION}/patches)
 endif()
 
 if(INSTALL_SCRIPTS)

data/CMakeLists.txt

@@ -24,6 +24,10 @@ install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/blueprints/
         FILES_MATCHING PATTERN "*"
                        PATTERN blueprints/test EXCLUDE)
 
+install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/patches/
+    DESTINATION ${DFHACK_DATA_DESTINATION}/patches
+)
+
 if(BUILD_TESTS)
     install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/blueprints/test/
             DESTINATION "${DFHACK_DATA_DESTINATION}/data/blueprints/test")

data/patches/README.md

@@ -0,0 +1,13 @@
+Place IDA-exported `.dif` files for use by `binpatch` in subdirectories of this
+directory. Each `.dif` file must be in a subdirectory named after the full
+symbol table version string. For example, for DF version 51.05, you would use
+these subdirectories:
+
+- "v0.51.05 linux64 CLASSIC"
+- "v0.51.05 linux64 ITCH"
+- "v0.51.05 linux64 STEAM"
+- "v0.51.05 win64 CLASSIC"
+- "v0.51.05 win64 ITCH"
+- "v0.51.05 win64 STEAM"
+
+See https://docs.dfhack.org/en/stable/docs/dev/Binpatches.html for more details.

docs/changelog.txt

@@ -58,7 +58,6 @@ Template for new versions:
 - `spectate`: new "cinematic-action" mode that dynamically speeds up perspective switches based on intensity of conflict
 - `spectate`: new global keybinding for toggling spectate mode: Ctrl-Shift-S
 - `spectate`: new overlay panel that allows you to cycle through following next/prevous units (regardless of whether spectate mode is enabled)
-- ``disable-vanilla-dimensions``: new binpatch to disable the vanilla dimensions tooltip
 - `gui/sitemap`: is now the official "go to" tool. new global hotkey for fort and adventure mode: Ctrl-G
 
 ## Fixes

docs/dev/Binpatches.rst

@@ -50,10 +50,20 @@ directly in memory at runtime::
 
 If the name of the patch has no extension or directory separators, the
 script uses :file:`hack/patches/<df-version>/<name>.dif`, thus auto-selecting
-the version appropriate for the currently loaded executable.
+the version appropriate for the currently loaded executable. The ``df-version``
+is the version string in the loaded symbol table. For example, if you want to
+make a patch for all distributed verisons of DF 51.05, you'd provide a ``dif``
+file in each of the following directories:
+
+- :file:`hack/patches/v0.51.05 linux64 CLASSIC/mypatch.dif`
+- :file:`hack/patches/v0.51.05 linux64 ITCH/mypatch.dif`
+- :file:`hack/patches/v0.51.05 linux64 STEAM/mypatch.dif`
+- :file:`hack/patches/v0.51.05 win64 CLASSIC/mypatch.dif`
+- :file:`hack/patches/v0.51.05 win64 ITCH/mypatch.dif`
+- :file:`hack/patches/v0.51.05 win64 STEAM/mypatch.dif`
 
 This is the preferred method; it's easier to debug, does not cause persistent
-problems, and leaves file checksums alone.  As with many other commands, users
+problems, and leaves file checksums alone. As with many other commands, users
 can simply add it to `dfhack.init` to reapply the patch every time DF is run.