Merge branch 'develop' into add_library_time_class

DFHack · Apr 30, 2024 · a24924c · a24924c
2 parents d56a9c2 + 959157b
commit a24924c
Show file tree

Hide file tree

Showing 356 changed files with 18,564 additions and 16,885 deletions.
diff --git a/.github/release_template.md b/.github/release_template.md
@@ -1,5 +1,5 @@
 #### 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`.
+**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`. If you are on Windows and are manually installing from the zip file, please remember to right click on the file after downloading, open the file properties, and select the "Unblock" checkbox. This will prevent issues with Windows antivirus programs.
 
 -------------
 
@@ -54,7 +54,7 @@ If you see a tool complaining about the lack of a cursor, know that it's referri
 
 </details>
 
-Generated release notes
+Changelog
 ====================
 
 <details>

diff --git a/.github/workflows/build-linux.yml b/.github/workflows/build-linux.yml
@@ -3,10 +3,19 @@ name: Build linux64
 on:
   workflow_call:
     inputs:
+      dfhack_repo:
+        type: string
+        default: DFHack/dfhack
       dfhack_ref:
         type: string
+      scripts_repo:
+        type: string
+        default: DFHack/scripts
       scripts_ref:
         type: string
+      structures_repo:
+        type: string
+        default: DFHack/df-structures
       structures_ref:
         type: string
       artifact-name:
@@ -23,6 +32,9 @@ on:
       platform-files:
         type: boolean
         default: true
+      plugins:
+        type: boolean
+        default: true
       common-files:
         type: boolean
         default: true
@@ -35,6 +47,9 @@ on:
       stonesense:
         type: boolean
         default: false
+      launchdf:
+        type: boolean
+        default: false
       extras:
         type: boolean
         default: false
@@ -70,31 +85,39 @@ jobs:
         run: sudo apt-get install libgl-dev
       - name: Install doc dependencies
         if: inputs.docs
-        run: pip install 'sphinx<4.4.0'
+        run: pip install 'sphinx'
       - name: Clone DFHack
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          repository: ${{ inputs.dfhack_ref && github.repository || 'DFHack/dfhack' }}
+          repository: ${{ inputs.dfhack_repo }}
           ref: ${{ inputs.dfhack_ref }}
           submodules: true
           fetch-depth: ${{ !inputs.platform-files && 1 || 0 }}
       - name: Clone scripts
         if: inputs.scripts_ref
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          repository: ${{ inputs.scripts_ref && github.repository || 'DFHack/scripts' }}
+          repository: ${{ inputs.scripts_repo }}
           ref: ${{ inputs.scripts_ref }}
           path: scripts
       - name: Clone structures
         if: inputs.structures_ref
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          repository: ${{ inputs.structures_ref && github.repository || 'DFHack/df-structures' }}
+          repository: ${{ inputs.structures_repo }}
           ref: ${{ inputs.structures_ref }}
           path: library/xml
+      - name: Get 3rd party SDKs
+        if: inputs.launchdf
+        uses: actions/checkout@v4
+        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
+        uses: actions/cache/restore@v4
         with:
           path: ~/.cache/ccache
           key: linux-gcc-${{ inputs.gcc-ver }}-${{ inputs.cache-id }}-${{ github.sha }}
@@ -115,8 +138,9 @@ jobs:
             ${{ 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_PLUGINS:BOOL=${{ inputs.platform-files && inputs.plugins }} \
             -DBUILD_STONESENSE:BOOL=${{ inputs.stonesense }} \
+            -DBUILD_DFLAUNCH:BOOL=${{ inputs.launchdf }} \
             -DBUILD_DEV_PLUGINS:BOOL=${{ inputs.extras }} \
             -DBUILD_SIZECHECK:BOOL=${{ inputs.extras }} \
             -DBUILD_SKELETON:BOOL=${{ inputs.extras }} \
@@ -142,7 +166,7 @@ jobs:
           ccache --zero-stats
       - name: Save ccache
         if: inputs.platform-files && !inputs.cache-readonly
-        uses: actions/cache/save@v3
+        uses: actions/cache/save@v4
         with:
           path: ~/.cache/ccache
           key: linux-gcc-${{ inputs.gcc-ver }}-${{ inputs.cache-id }}-${{ github.sha }}
@@ -162,7 +186,7 @@ jobs:
           tar cjf ../../${{ steps.artifactname.outputs.name }}.tar.bz2 .
       - name: Upload artifact
         if: inputs.artifact-name
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.artifactname.outputs.name }}
           path: ${{ steps.artifactname.outputs.name }}.tar.bz2
diff --git a/.github/workflows/build-windows.yml b/.github/workflows/build-windows.yml
@@ -3,10 +3,19 @@ name: Build win64
 on:
   workflow_call:
     inputs:
+      dfhack_repo:
+        type: string
+        default: DFHack/dfhack
       dfhack_ref:
         type: string
+      scripts_repo:
+        type: string
+        default: DFHack/scripts
       scripts_ref:
         type: string
+      structures_repo:
+        type: string
+        default: DFHack/df-structures
       structures_ref:
         type: string
       artifact-name:
@@ -56,37 +65,37 @@ jobs:
           sudo apt-get update
           sudo apt-get install ccache
       - name: Clone DFHack
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          repository: ${{ inputs.dfhack_ref && github.repository || 'DFHack/dfhack' }}
+          repository: ${{ inputs.dfhack_repo }}
           ref: ${{ inputs.dfhack_ref }}
           submodules: true
           fetch-depth: 0
       - name: Clone scripts
         if: inputs.scripts_ref
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          repository: ${{ inputs.scripts_ref && github.repository || 'DFHack/scripts' }}
+          repository: ${{ inputs.scripts_repo }}
           ref: ${{ inputs.scripts_ref }}
           path: scripts
       - name: Clone structures
         if: inputs.structures_ref
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          repository: ${{ inputs.structures_ref && github.repository || 'DFHack/df-structures' }}
+          repository: ${{ inputs.structures_repo }}
           ref: ${{ inputs.structures_ref }}
           path: library/xml
       - name: Get 3rd party SDKs
         if: inputs.launchdf
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         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
+        uses: actions/cache/restore@v4
         with:
           path: build/win64-cross/ccache
           key: win-msvc-${{ inputs.cache-id }}-${{ github.sha }}
@@ -109,7 +118,7 @@ jobs:
           ccache -d win64-cross/ccache --zero-stats
       - name: Save ccache
         if: inputs.platform-files && !inputs.cache-readonly
-        uses: actions/cache/save@v3
+        uses: actions/cache/save@v4
         with:
           path: build/win64-cross/ccache
           key: win-msvc-${{ inputs.cache-id }}-${{ github.sha }}
@@ -129,7 +138,7 @@ jobs:
           tar cjf ../../../${{ steps.artifactname.outputs.name }}.tar.bz2 .
       - name: Upload artifact
         if: inputs.artifact-name
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.artifactname.outputs.name }}
           path: ${{ steps.artifactname.outputs.name }}.tar.bz2
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -6,18 +6,21 @@ jobs:
   test:
     uses: ./.github/workflows/test.yml
     with:
+      dfhack_repo: ${{ github.repository }}
       dfhack_ref: ${{ github.ref }}
     secrets: inherit
 
   package:
     uses: ./.github/workflows/package.yml
     with:
+      dfhack_repo: ${{ github.repository }}
       dfhack_ref: ${{ github.ref }}
     secrets: inherit
 
   docs:
     uses: ./.github/workflows/build-linux.yml
     with:
+      dfhack_repo: ${{ github.repository }}
       dfhack_ref: ${{ github.ref }}
       platform-files: false
       common-files: false
@@ -27,6 +30,7 @@ jobs:
   lint:
     uses: ./.github/workflows/lint.yml
     with:
+      dfhack_repo: ${{ github.repository }}
       dfhack_ref: ${{ github.ref }}
     secrets: inherit
 

diff --git a/.github/workflows/clean-cache.yml b/.github/workflows/clean-cache.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Cleanup
         run: |
           gh extension install actions/gh-actions-cache