Merge branch 'develop' into myk_hawkowl

.github/release_template.md

@@ -0,0 +1,64 @@
+#### Q: How do I download DFHack?
+**A:** Either add to your Steam library from our [Steam page](https://store.steampowered.com/app/2346660/DFHack) or scroll to the latest release on our [GitHub releases page](https://github.com/DFHack/dfhack/releases), expand the "Assets" list, and download the file for your platform (e.g. `dfhack-XX.XX-rX-Windows-64bit.zip`.
+
+-------------
+
+This release is compatible with all distributions of Dwarf Fortress: [Steam](https://store.steampowered.com/app/975370/Dwarf_Fortress/), [Itch](https://kitfoxgames.itch.io/dwarf-fortress), and [Classic](https://www.bay12games.com/dwarves/).
+
+- [Install DFHack from Steam](https://store.steampowered.com/app/2346660/DFHack)
+- [Manual install](https://docs.dfhack.org/en/stable/docs/Installing.html#installing)
+- [Quickstart guide (for players)](https://docs.dfhack.org/en/stable/docs/Quickstart.html#quickstart)
+- [Modding guide (for modders)](https://docs.dfhack.org/en/stable/docs/guides/modding-guide.html)
+
+Please report any issues (or feature requests) on the DFHack [GitHub issue tracker](https://github.com/DFHack/dfhack/issues). When reporting issues, please upload a zip file of your savegame and a zip file of your `mods` directory to the cloud and add links to the GitHub issue. Make sure your files are downloadable by "everyone with the link". We need your savegame to reproduce the problem and test the fix, and we need your active mods so we can load your savegame. Issues with savegames and mods attached get fixed first!
+
+Highlights
+----------------------------------
+
+<details>
+<summary>Highlight 1, Highlight 2</summary>
+
+### Highlight 1
+
+Demo screenshot/vidcap
+
+Text
+
+### Highlight 2
+
+Demo screenshot/vidcap
+
+Text
+
+</details>
+
+Announcements
+----------------------------------
+
+<details>
+<summary>Annc 1, PSAs</summary>
+
+### Annc 1
+
+Text
+
+### PSAs
+
+As always, remember that, just like the vanilla DF game, DFHack tools can also have bugs. It is a good idea to **save often and keep backups** of the forts that you care about.
+
+Many DFHack tools that worked in previous (pre-Steam) versions of DF have not been updated yet and are marked with the "unavailable" tag in their docs. If you try to run them, they will show a warning and exit immediately. You can run the command again to override the warning (though of course the tools may not work). We make no guarantees of reliability for the tools that are marked as "unavailable".
+
+The in-game interface for running DFHack commands (`gui/launcher`) will not show "unavailable" tools by default. You can still run them if you know their names, or you can turn on dev mode by hitting Ctrl-D while in `gui/launcher` and they will be added to the autocomplete list. Some tools do not compile yet and are not available at all, even when in dev mode.
+
+If you see a tool complaining about the lack of a cursor, know that it's referring to the **keyboard** cursor (which used to be the only real option in Dwarf Fortress). You can enable the keyboard cursor by entering mining mode or selecting the dump/forbid tool and hitting Alt-K (the DFHack keybinding for `toggle-kbd-cursor`). We're working on making DFHack tools more mouse-aware and accessible so this step isn't necessary in the future.
+
+</details>
+
+Generated release notes
+====================
+
+<details>
+<summary>New tools, fixes, and improvements</summary>
+
+%RELEASE_NOTES%
+</details>

.github/workflows/build-linux.yml

@@ -0,0 +1,168 @@
+name: Build linux64
+
+on:
+  workflow_call:
+    inputs:
+      dfhack_ref:
+        type: string
+      scripts_ref:
+        type: string
+      structures_ref:
+        type: string
+      artifact-name:
+        type: string
+      append-date-and-hash:
+        type: boolean
+        default: false
+      cache-id:
+        type: string
+        default: ''
+      cache-readonly:
+        type: boolean
+        default: false
+      platform-files:
+        type: boolean
+        default: true
+      common-files:
+        type: boolean
+        default: true
+      docs:
+        type: boolean
+        default: false
+      html:
+        type: boolean
+        default: true
+      stonesense:
+        type: boolean
+        default: false
+      extras:
+        type: boolean
+        default: false
+      tests:
+        type: boolean
+        default: false
+      xml-dump-type-sizes:
+        type: boolean
+        default: false
+      gcc-ver:
+        type: string
+        default: "10"
+
+jobs:
+  build-linux64:
+    name: Build linux64
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Install basic build dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install ninja-build
+      - name: Install binary build dependencies
+        if: inputs.platform-files || inputs.xml-dump-type-sizes
+        run: |
+          sudo apt-get install \
+              ccache \
+              gcc-${{ inputs.gcc-ver }} \
+              g++-${{ inputs.gcc-ver }} \
+              libxml-libxslt-perl
+      - name: Install stonesense dependencies
+        if: inputs.stonesense
+        run: sudo apt-get install libgl-dev
+      - name: Install doc dependencies
+        if: inputs.docs
+        run: pip install 'sphinx<4.4.0'
+      - name: Clone DFHack
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ inputs.dfhack_ref && github.repository || 'DFHack/dfhack' }}
+          ref: ${{ inputs.dfhack_ref }}
+          submodules: true
+          fetch-depth: ${{ !inputs.platform-files && 1 || 0 }}
+      - name: Clone scripts
+        if: inputs.scripts_ref
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ inputs.scripts_ref && github.repository || 'DFHack/scripts' }}
+          ref: ${{ inputs.scripts_ref }}
+          path: scripts
+      - name: Clone structures
+        if: inputs.structures_ref
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ inputs.structures_ref && github.repository || 'DFHack/df-structures' }}
+          ref: ${{ inputs.structures_ref }}
+          path: library/xml
+      - name: Fetch ccache
+        if: inputs.platform-files
+        uses: actions/cache/restore@v3
+        with:
+          path: ~/.cache/ccache
+          key: linux-gcc-${{ inputs.gcc-ver }}-${{ inputs.cache-id }}-${{ github.sha }}
+          restore-keys: |
+            linux-gcc-${{ inputs.gcc-ver }}-${{ inputs.cache-id }}
+            linux-gcc-${{ inputs.gcc-ver }}
+      - name: Configure DFHack
+        env:
+          CC: gcc-${{ inputs.gcc-ver }}
+          CXX: g++-${{ inputs.gcc-ver }}
+        run: |
+          cmake \
+            -S . \
+            -B build \
+            -G Ninja \
+            -DCMAKE_INSTALL_PREFIX=build/image \
+            -DCMAKE_BUILD_TYPE=Release \
+            ${{ inputs.platform-files && '-DCMAKE_C_COMPILER_LAUNCHER=ccache' || '' }} \
+            ${{ inputs.platform-files && '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache' || '' }} \
+            -DBUILD_LIBRARY:BOOL=${{ inputs.platform-files }} \
+            -DBUILD_PLUGINS:BOOL=${{ inputs.platform-files }} \
+            -DBUILD_STONESENSE:BOOL=${{ inputs.stonesense }} \
+            -DBUILD_DEV_PLUGINS:BOOL=${{ inputs.extras }} \
+            -DBUILD_SIZECHECK:BOOL=${{ inputs.extras }} \
+            -DBUILD_SKELETON:BOOL=${{ inputs.extras }} \
+            -DBUILD_DOCS:BOOL=${{ inputs.docs }} \
+            -DBUILD_DOCS_NO_HTML:BOOL=${{ !inputs.html }} \
+            -DBUILD_TESTS:BOOL=${{ inputs.tests }} \
+            -DBUILD_XMLDUMP:BOOL=${{ inputs.xml-dump-type-sizes }} \
+            ${{ inputs.xml-dump-type-sizes && '-DINSTALL_XMLDUMP:BOOL=1' || ''}} \
+            -DINSTALL_DATA_FILES:BOOL=${{ inputs.common-files }} \
+            -DINSTALL_SCRIPTS:BOOL=${{ inputs.common-files }}
+      - name: Build DFHack
+        run: ninja -C build install
+      - name: Run cpp tests
+        if: inputs.platform-files
+        run: ninja -C build test
+      - name: Finalize cache
+        if: inputs.platform-files
+        run: |
+          ccache --show-stats --verbose
+          ccache --max-size 40M
+          ccache --cleanup
+          ccache --max-size 500M
+          ccache --zero-stats
+      - name: Save ccache
+        if: inputs.platform-files && !inputs.cache-readonly
+        uses: actions/cache/save@v3
+        with:
+          path: ~/.cache/ccache
+          key: linux-gcc-${{ inputs.gcc-ver }}-${{ inputs.cache-id }}-${{ github.sha }}
+      - name: Format artifact name
+        if: inputs.artifact-name
+        id: artifactname
+        run: |
+          if test "false" = "${{ inputs.append-date-and-hash }}"; then
+            echo name=${{ inputs.artifact-name }} >> $GITHUB_OUTPUT
+          else
+            echo name=${{ inputs.artifact-name }}-$(date +%Y%m%d)-$(git rev-parse --short HEAD) >> $GITHUB_OUTPUT
+          fi
+      - name: Prep artifact
+        if: inputs.artifact-name
+        run: |
+          cd build/image
+          tar cjf ../../${{ steps.artifactname.outputs.name }}.tar.bz2 .
+      - name: Upload artifact
+        if: inputs.artifact-name
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ steps.artifactname.outputs.name }}
+          path: ${{ steps.artifactname.outputs.name }}.tar.bz2

.github/workflows/build-windows.yml

@@ -0,0 +1,135 @@
+name: Build win64
+
+on:
+  workflow_call:
+    inputs:
+      dfhack_ref:
+        type: string
+      scripts_ref:
+        type: string
+      structures_ref:
+        type: string
+      artifact-name:
+        type: string
+      append-date-and-hash:
+        type: boolean
+        default: false
+      cache-id:
+        type: string
+        default: ''
+      cache-readonly:
+        type: boolean
+        default: false
+      platform-files:
+        type: boolean
+        default: true
+      common-files:
+        type: boolean
+        default: true
+      docs:
+        type: boolean
+        default: false
+      html:
+        type: boolean
+        default: true
+      stonesense:
+        type: boolean
+        default: false
+      tests:
+        type: boolean
+        default: false
+      xml-dump-type-sizes:
+        type: boolean
+        default: false
+      launchdf:
+        type: boolean
+        default: false
+
+
+jobs:
+  build-win64:
+    name: Build win64
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install ccache
+      - name: Clone DFHack
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ inputs.dfhack_ref && github.repository || 'DFHack/dfhack' }}
+          ref: ${{ inputs.dfhack_ref }}
+          submodules: true
+          fetch-depth: 0
+      - name: Clone scripts
+        if: inputs.scripts_ref
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ inputs.scripts_ref && github.repository || 'DFHack/scripts' }}
+          ref: ${{ inputs.scripts_ref }}
+          path: scripts
+      - name: Clone structures
+        if: inputs.structures_ref
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ inputs.structures_ref && github.repository || 'DFHack/df-structures' }}
+          ref: ${{ inputs.structures_ref }}
+          path: library/xml
+      - name: Get 3rd party SDKs
+        if: inputs.launchdf
+        uses: actions/checkout@v3
+        with:
+          repository: DFHack/3rdparty
+          ref: main
+          ssh-key: ${{ secrets.DFHACK_3RDPARTY_TOKEN }}
+          path: depends/steam
+      - name: Fetch ccache
+        if: inputs.platform-files
+        uses: actions/cache/restore@v3
+        with:
+          path: build/win64-cross/ccache
+          key: win-msvc-${{ inputs.cache-id }}-${{ github.sha }}
+          restore-keys: |
+            win-msvc-${{ inputs.cache-id }}
+            win-msvc
+      - name: Cross-compile
+        env:
+          CMAKE_EXTRA_ARGS: -DBUILD_LIBRARY=${{ inputs.platform-files }} -DBUILD_STONESENSE:BOOL=${{ inputs.stonesense }} -DBUILD_DOCS:BOOL=${{ inputs.docs }} -DBUILD_DOCS_NO_HTML:BOOL=${{ !inputs.html }} -DINSTALL_DATA_FILES:BOOL=${{ inputs.common-files }} -DINSTALL_SCRIPTS:BOOL=${{ inputs.common-files }} -DBUILD_DFLAUNCH:BOOL=${{ inputs.launchdf }} -DBUILD_TESTS:BOOL=${{ inputs.tests }} -DBUILD_XMLDUMP:BOOL=${{ inputs.xml-dump-type-sizes }} ${{ inputs.xml-dump-type-sizes && '-DINSTALL_XMLDUMP:BOOL=1' || '' }}
+        run: |
+          cd build
+          bash -x build-win64-from-linux.sh
+      - name: Finalize cache
+        run: |
+          cd build
+          ccache -d win64-cross/ccache --show-stats --verbose
+          ccache -d win64-cross/ccache --max-size 150M
+          ccache -d win64-cross/ccache --cleanup
+          ccache -d win64-cross/ccache --max-size 500M
+          ccache -d win64-cross/ccache --zero-stats
+      - name: Save ccache
+        if: inputs.platform-files && !inputs.cache-readonly
+        uses: actions/cache/save@v3
+        with:
+          path: build/win64-cross/ccache
+          key: win-msvc-${{ inputs.cache-id }}-${{ github.sha }}
+      - name: Format artifact name
+        if: inputs.artifact-name
+        id: artifactname
+        run: |
+          if test "false" = "${{ inputs.append-date-and-hash }}"; then
+            echo name=${{ inputs.artifact-name }} >> $GITHUB_OUTPUT
+          else
+            echo name=${{ inputs.artifact-name }}-$(date +%Y%m%d)-$(git rev-parse --short HEAD) >> $GITHUB_OUTPUT
+          fi
+      - name: Prep artifact
+        if: inputs.artifact-name
+        run: |
+          cd build/win64-cross/output
+          tar cjf ../../../${{ steps.artifactname.outputs.name }}.tar.bz2 .
+      - name: Upload artifact
+        if: inputs.artifact-name
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ steps.artifactname.outputs.name }}
+          path: ${{ steps.artifactname.outputs.name }}.tar.bz2