Merge branch 'develop' into remoteserver_accept_fix
Myk
GitHub
commit
d65ef21251
@ -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>
|
||||
@ -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
|
||||
@ -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
|
||||
@ -1,35 +0,0 @@
|
||||
name: Buildmaster rebuild
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
pull_request:
|
||||
description: Pull request ID
|
||||
type: string
|
||||
required: true # remove if we support commit rebuilds later
|
||||
|
||||
jobs:
|
||||
rebuild:
|
||||
runs-on: ubuntu-latest
|
||||
name: Trigger Buildmaster
|
||||
steps:
|
||||
- name: Set up Python 3
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: 3
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
pip install requests
|
||||
- name: Clone DFHack
|
||||
uses: actions/checkout@v1
|
||||
with:
|
||||
fetch-depth: 1
|
||||
submodules: false
|
||||
- name: Run
|
||||
env:
|
||||
DFHACK_BUILDMASTER_WEBHOOK_URL: ${{ secrets.DFHACK_BUILDMASTER_WEBHOOK_URL }}
|
||||
DFHACK_BUILDMASTER_WEBHOOK_SECRET: ${{ secrets.DFHACK_BUILDMASTER_WEBHOOK_SECRET }}
|
||||
GITHUB_REPO: ${{ github.repository }}
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
run: |
|
||||
python ci/buildmaster-rebuild-pr.py --pull-request ${{ github.event.inputs.pull_request }}
|
||||
@ -0,0 +1,81 @@
|
||||
name: Deploy to GitHub
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*-r*'
|
||||
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
ref:
|
||||
description: Tag
|
||||
required: true
|
||||
|
||||
jobs:
|
||||
package:
|
||||
uses: ./.github/workflows/package.yml
|
||||
with:
|
||||
dfhack_ref: ${{ github.event.inputs && github.event.inputs.ref || github.event.ref }}
|
||||
append-date-and-hash: false
|
||||
cache-readonly: true
|
||||
launchdf: true
|
||||
secrets: inherit
|
||||
|
||||
create-update-release:
|
||||
name: Draft GitHub release
|
||||
needs: package
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Install doc dependencies
|
||||
run: pip install 'sphinx<4.4.0'
|
||||
- name: Clone DFHack
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
ref: ${{ github.event.inputs && github.event.inputs.ref || github.event.ref }}
|
||||
submodules: true
|
||||
- name: Get tag
|
||||
id: gettag
|
||||
run: |
|
||||
TAG=$(git describe --tags --abbrev=0 --exact-match)
|
||||
echo name="$TAG" >> $GITHUB_OUTPUT
|
||||
echo type=$(echo "$TAG" | egrep 'r[0-9]+$' && echo "release" || echo "prerelease") >> $GITHUB_OUTPUT
|
||||
- name: Generate release text
|
||||
run: |
|
||||
python docs/gen_changelog.py -a
|
||||
CHANGELOG_FILE=docs/changelogs/${{ steps.gettag.outputs.name }}-github.txt
|
||||
if ! test -f $CHANGELOG_FILE; then CHANGELOG_FILE=docs/changelogs/future-github.txt; fi
|
||||
TOKEN_LINE=$(grep -Fhne '%RELEASE_NOTES%' .github/release_template.md | sed 's/:.*//')
|
||||
head -n $((TOKEN_LINE - 1)) .github/release_template.md > release_body.md
|
||||
CHANGELOG_LINES=$(wc -l <$CHANGELOG_FILE)
|
||||
tail -n $((CHANGELOG_LINES - 4)) $CHANGELOG_FILE >> release_body.md
|
||||
tail -n 1 .github/release_template.md >> release_body.md
|
||||
cat release_body.md
|
||||
- name: Stage release
|
||||
uses: actions/download-artifact@v3
|
||||
- name: Prep artifacts
|
||||
run: |
|
||||
mkdir artifacts
|
||||
cd dfhack-windows64-build
|
||||
tar xjf dfhack-windows64-build.tar.bz2
|
||||
rm dfhack-windows64-build.tar.bz2
|
||||
zip -qr ../artifacts/dfhack-${{ steps.gettag.outputs.name }}-Windows-64bit.zip .
|
||||
cd ../dfhack-linux64-build
|
||||
mv dfhack-linux64-build.tar.bz2 ../artifacts/dfhack-${{ steps.gettag.outputs.name }}-Linux-64bit.tar.bz2
|
||||
- name: Create or update GitHub release
|
||||
uses: ncipollo/release-action@v1
|
||||
with:
|
||||
artifacts: "artifacts/dfhack-*"
|
||||
bodyFile: "release_body.md"
|
||||
allowUpdates: true
|
||||
artifactErrorsFailBuild: true
|
||||
draft: true
|
||||
name: "DFHack ${{ steps.gettag.outputs.name }}"
|
||||
omitBodyDuringUpdate: true
|
||||
omitDraftDuringUpdate: true
|
||||
omitNameDuringUpdate: true
|
||||
omitPrereleaseDuringUpdate: true
|
||||
prerelease: ${{ steps.gettag.outputs.type == 'prerelease' }}
|
||||
replacesArtifacts: true
|
||||
tag: ${{ steps.gettag.outputs.name }}
|
||||
@ -0,0 +1,44 @@
|
||||
name: Lint
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
dfhack_ref:
|
||||
type: string
|
||||
scripts_ref:
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Install Lua
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install lua5.3
|
||||
- name: Clone DFHack
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
repository: ${{ inputs.dfhack_ref && github.repository || 'DFHack/dfhack' }}
|
||||
ref: ${{ inputs.dfhack_ref }}
|
||||
- name: Get scripts submodule ref
|
||||
if: '!inputs.scripts_ref'
|
||||
id: scriptssubmoduleref
|
||||
run: echo ref=$(git submodule | fgrep scripts | cut -c2-41) >> $GITHUB_OUTPUT
|
||||
- name: Clone scripts
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
repository: ${{ inputs.scripts_ref && github.repository || 'DFHack/scripts' }}
|
||||
ref: ${{ inputs.scripts_ref || steps.scriptssubmoduleref.outputs.ref }}
|
||||
path: scripts
|
||||
- name: Check whitespace
|
||||
run: python ci/lint.py --git-only --github-actions
|
||||
- name: Check Authors.rst
|
||||
if: always()
|
||||
run: python ci/authors-rst.py
|
||||
- name: Check for missing documentation
|
||||
if: always()
|
||||
run: python ci/script-docs.py
|
||||
- name: Check Lua syntax
|
||||
if: always()
|
||||
run: python ci/script-syntax.py --ext=lua --cmd="luac5.3 -p" --github-actions
|
||||
@ -0,0 +1,52 @@
|
||||
name: Package
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
dfhack_ref:
|
||||
type: string
|
||||
scripts_ref:
|
||||
type: string
|
||||
structures_ref:
|
||||
type: string
|
||||
append-date-and-hash:
|
||||
type: boolean
|
||||
default: true
|
||||
cache-readonly:
|
||||
type: boolean
|
||||
default: false
|
||||
launchdf:
|
||||
type: boolean
|
||||
default: false
|
||||
|
||||
jobs:
|
||||
package-win64:
|
||||
name: Windows
|
||||
uses: ./.github/workflows/build-windows.yml
|
||||
with:
|
||||
dfhack_ref: ${{ inputs.dfhack_ref }}
|
||||
scripts_ref: ${{ inputs.scripts_ref }}
|
||||
structures_ref: ${{ inputs.structures_ref }}
|
||||
artifact-name: dfhack-windows64-build
|
||||
append-date-and-hash: ${{ inputs.append-date-and-hash }}
|
||||
cache-id: release
|
||||
cache-readonly: ${{ inputs.cache-readonly }}
|
||||
stonesense: true
|
||||
docs: true
|
||||
launchdf: ${{ inputs.launchdf }}
|
||||
secrets: inherit
|
||||
|
||||
package-linux:
|
||||
name: Linux
|
||||
uses: ./.github/workflows/build-linux.yml
|
||||
with:
|
||||
dfhack_ref: ${{ inputs.dfhack_ref }}
|
||||
scripts_ref: ${{ inputs.scripts_ref }}
|
||||
structures_ref: ${{ inputs.structures_ref }}
|
||||
artifact-name: dfhack-linux64-build
|
||||
append-date-and-hash: ${{ inputs.append-date-and-hash }}
|
||||
cache-id: release
|
||||
cache-readonly: ${{ inputs.cache-readonly }}
|
||||
stonesense: true
|
||||
docs: true
|
||||
secrets: inherit
|
||||
@ -0,0 +1,92 @@
|
||||
name: Deploy to Steam
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*-r*'
|
||||
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
ref:
|
||||
description: Branch or commit hash
|
||||
type: string
|
||||
required: true
|
||||
default: develop
|
||||
version:
|
||||
description: Version or build description
|
||||
type: string
|
||||
required: true
|
||||
release_channel:
|
||||
description: Steam release channel
|
||||
type: string
|
||||
required: true
|
||||
default: staging
|
||||
|
||||
jobs:
|
||||
depot-common:
|
||||
name: Common depot files
|
||||
uses: ./.github/workflows/build-linux.yml
|
||||
with:
|
||||
artifact-name: common-depot
|
||||
dfhack_ref: ${{ github.event.inputs && github.event.inputs.ref || github.event.ref }}
|
||||
platform-files: false
|
||||
docs: true
|
||||
stonesense: true
|
||||
secrets: inherit
|
||||
|
||||
depot-win64:
|
||||
name: Windows depot files
|
||||
uses: ./.github/workflows/build-windows.yml
|
||||
with:
|
||||
artifact-name: win64-depot
|
||||
dfhack_ref: ${{ github.event.inputs && github.event.inputs.ref || github.event.ref }}
|
||||
cache-id: release
|
||||
cache-readonly: true
|
||||
common-files: false
|
||||
stonesense: true
|
||||
launchdf: true
|
||||
secrets: inherit
|
||||
|
||||
depot-linux64:
|
||||
name: Linux depot files
|
||||
uses: ./.github/workflows/build-linux.yml
|
||||
with:
|
||||
artifact-name: linux64-depot
|
||||
dfhack_ref: ${{ github.event.inputs && github.event.inputs.ref || github.event.ref }}
|
||||
cache-id: release
|
||||
cache-readonly: true
|
||||
common-files: false
|
||||
stonesense: true
|
||||
secrets: inherit
|
||||
|
||||
deploy-to-steam:
|
||||
name: Deploy to Steam
|
||||
needs:
|
||||
- depot-common
|
||||
- depot-win64
|
||||
- depot-linux64
|
||||
runs-on: ubuntu-latest
|
||||
concurrency: steam
|
||||
steps:
|
||||
- name: Download depot files
|
||||
uses: actions/download-artifact@v3
|
||||
- name: Stage depot files
|
||||
run: |
|
||||
for name in common win64 linux64; do
|
||||
cd ${name}-depot
|
||||
tar xjf ${name}-depot.tar.bz2
|
||||
rm ${name}-depot.tar.bz2
|
||||
cd ..
|
||||
done
|
||||
- name: Steam deploy
|
||||
uses: game-ci/steam-deploy@v3
|
||||
with:
|
||||
username: ${{ secrets.STEAM_USERNAME }}
|
||||
configVdf: ${{ secrets.STEAM_CONFIG_VDF}}
|
||||
appId: 2346660
|
||||
buildDescription: ${{ github.event.inputs && github.event.inputs.version || github.ref_name }}
|
||||
rootPath: .
|
||||
depot1Path: common-depot
|
||||
depot2Path: win64-depot
|
||||
depot3Path: linux64-depot
|
||||
releaseBranch: ${{ github.event.inputs && github.event.inputs.release_channel || 'staging' }}
|
||||
@ -1,78 +0,0 @@
|
||||
name: Deploy to Steam
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
ref:
|
||||
description: Branch or commit hash
|
||||
type: string
|
||||
required: true
|
||||
default: develop
|
||||
version:
|
||||
description: Version or build description
|
||||
type: string
|
||||
required: true
|
||||
release_channel:
|
||||
description: Release channel
|
||||
type: string
|
||||
required: true
|
||||
default: staging
|
||||
|
||||
jobs:
|
||||
deploy-to-steam:
|
||||
name: Deploy to Steam
|
||||
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:
|
||||
submodules: true
|
||||
fetch-depth: 0
|
||||
ref: ${{ github.event.inputs.ref }}
|
||||
- name: Get 3rd party SDKs
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
repository: DFHack/3rdparty
|
||||
ref: main
|
||||
ssh-key: ${{ secrets.DFHACK_3RDPARTY_TOKEN }}
|
||||
path: depends/steam
|
||||
- name: Fetch ccache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: build/win64-cross/ccache
|
||||
key: ccache-win64-cross-msvc-${{ github.sha }}
|
||||
restore-keys: |
|
||||
ccache-win64-cross-msvc
|
||||
- name: Cross-compile win64 artifacts
|
||||
env:
|
||||
CMAKE_EXTRA_ARGS: '-DBUILD_STONESENSE:BOOL=1 -DBUILD_DFLAUNCH:BOOL=1'
|
||||
steam_username: ${{ secrets.STEAM_SDK_USERNAME }}
|
||||
steam_password: ${{ secrets.STEAM_SDK_PASSWORD }}
|
||||
run: |
|
||||
echo "ref: ${{ github.event.inputs.ref }}"
|
||||
echo "sha: ${{ github.sha }}"
|
||||
echo "version: ${{ github.event.inputs.version }}"
|
||||
echo "release_channel: ${{ github.event.inputs.release_channel }}"
|
||||
echo
|
||||
cd build
|
||||
bash -x build-win64-from-linux.sh
|
||||
ccache -d win64-cross/ccache --max-size 200M
|
||||
ccache -d win64-cross/ccache --cleanup
|
||||
ccache -d win64-cross/ccache --show-stats
|
||||
- name: Steam deploy
|
||||
uses: game-ci/steam-deploy@v2
|
||||
with:
|
||||
username: ${{ secrets.STEAM_USERNAME }}
|
||||
password: ${{ secrets.STEAM_PASSWORD }}
|
||||
configVdf: ${{ secrets.STEAM_CONFIG_VDF}}
|
||||
ssfnFileName: ${{ secrets.STEAM_SSFN_FILE_NAME }}
|
||||
ssfnFileContents: ${{ secrets.STEAM_SSFN_FILE_CONTENTS }}
|
||||
appId: 2346660
|
||||
buildDescription: ${{ github.event.inputs.version }}
|
||||
rootPath: build
|
||||
depot1Path: win64-cross/output
|
||||
releaseBranch: ${{ github.event.inputs.release_channel }}
|
||||
@ -0,0 +1,146 @@
|
||||
name: Test
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
dfhack_ref:
|
||||
type: string
|
||||
scripts_ref:
|
||||
type: string
|
||||
structures_ref:
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
build-windows:
|
||||
name: Windows MSVC
|
||||
uses: ./.github/workflows/build-windows.yml
|
||||
with:
|
||||
dfhack_ref: ${{ inputs.dfhack_ref }}
|
||||
scripts_ref: ${{ inputs.scripts_ref }}
|
||||
structures_ref: ${{ inputs.structures_ref }}
|
||||
artifact-name: test-msvc
|
||||
cache-id: test
|
||||
docs: true
|
||||
html: false
|
||||
tests: true
|
||||
|
||||
build-linux:
|
||||
name: Linux gcc-${{ matrix.gcc }}
|
||||
uses: ./.github/workflows/build-linux.yml
|
||||
with:
|
||||
dfhack_ref: ${{ inputs.dfhack_ref }}
|
||||
scripts_ref: ${{ inputs.scripts_ref }}
|
||||
structures_ref: ${{ inputs.structures_ref }}
|
||||
artifact-name: test-gcc-${{ matrix.gcc }}
|
||||
cache-id: test
|
||||
stonesense: ${{ matrix.plugins == 'all' }}
|
||||
extras: ${{ matrix.plugins == 'all' }}
|
||||
docs: true
|
||||
html: false
|
||||
tests: true
|
||||
gcc-ver: ${{ matrix.gcc }}
|
||||
secrets: inherit
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- gcc: 10
|
||||
plugins: "default"
|
||||
- gcc: 12
|
||||
plugins: "all"
|
||||
|
||||
run-tests:
|
||||
name: Test (${{ matrix.os }}, ${{ matrix.compiler }}, ${{ matrix.plugins }} plugins, ${{ matrix.config }} config)
|
||||
needs:
|
||||
- build-windows
|
||||
- build-linux
|
||||
runs-on: ${{ matrix.os }}-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- os: windows
|
||||
compiler: msvc
|
||||
plugins: "default"
|
||||
config: "default"
|
||||
- os: windows
|
||||
compiler: msvc
|
||||
plugins: "default"
|
||||
config: "empty"
|
||||
- os: ubuntu
|
||||
compiler: gcc-10
|
||||
plugins: "default"
|
||||
config: "default"
|
||||
- os: ubuntu
|
||||
compiler: gcc-12
|
||||
plugins: "all"
|
||||
config: "default"
|
||||
steps:
|
||||
- name: Set env
|
||||
shell: bash
|
||||
run: echo "DF_FOLDER=DF" >> $GITHUB_ENV
|
||||
- name: Install dependencies
|
||||
if: matrix.os == 'ubuntu'
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install \
|
||||
libsdl2-2.0-0 \
|
||||
libsdl2-image-2.0-0
|
||||
- name: Clone DFHack
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
repository: ${{ inputs.dfhack_ref && github.repository || 'DFHack/dfhack' }}
|
||||
ref: ${{ inputs.dfhack_ref }}
|
||||
- name: Detect DF version
|
||||
shell: bash
|
||||
run: echo DF_VERSION="$(sh ci/get-df-version.sh)" >> $GITHUB_ENV
|
||||
- name: Fetch DF cache
|
||||
id: restore-df
|
||||
uses: actions/cache/restore@v3
|
||||
with:
|
||||
path: ${{ env.DF_FOLDER }}
|
||||
key: df-${{ matrix.os }}-${{ env.DF_VERSION }}-${{ hashFiles('ci/download-df.sh') }}
|
||||
- name: Download DF
|
||||
if: steps.restore-df.outputs.cache-hit != 'true'
|
||||
run: sh ci/download-df.sh ${{ env.DF_FOLDER }} ${{ matrix.os }} ${{ env.DF_VERSION }}
|
||||
- name: Save DF cache
|
||||
if: steps.restore-df.outputs.cache-hit != 'true'
|
||||
uses: actions/cache/save@v3
|
||||
with:
|
||||
path: ${{ env.DF_FOLDER }}
|
||||
key: df-${{ matrix.os }}-${{ env.DF_VERSION }}-${{ hashFiles('ci/download-df.sh') }}
|
||||
- name: Install blank DFHack init scripts
|
||||
if: matrix.config == 'empty'
|
||||
shell: bash
|
||||
run: |
|
||||
mkdir -p ${{ env.DF_FOLDER }}/dfhack-config/init
|
||||
cd data/dfhack-config/init
|
||||
for fname in *.init; do touch ../../../${{ env.DF_FOLDER }}/dfhack-config/init/$fname; done
|
||||
- name: Download DFHack
|
||||
uses: actions/download-artifact@v3
|
||||
with:
|
||||
name: test-${{ matrix.compiler }}
|
||||
- name: Install DFHack
|
||||
shell: bash
|
||||
run: tar xjf test-${{ matrix.compiler }}.tar.bz2 -C ${{ env.DF_FOLDER }}
|
||||
- name: Start X server
|
||||
if: matrix.os == 'ubuntu'
|
||||
run: Xvfb :0 -screen 0 1600x1200x24 &
|
||||
- name: Run lua tests
|
||||
timeout-minutes: 10
|
||||
env:
|
||||
DISPLAY: :0
|
||||
TERM: xterm-256color
|
||||
run: python ci/run-tests.py --keep-status "${{ env.DF_FOLDER }}"
|
||||
- name: Check RPC interface
|
||||
run: python ci/check-rpc.py "${{ env.DF_FOLDER }}/dfhack-rpc.txt"
|
||||
- name: Upload test artifacts
|
||||
uses: actions/upload-artifact@v3
|
||||
if: always()
|
||||
continue-on-error: true
|
||||
with:
|
||||
name: test-output-${{ matrix.compiler }}-${{ matrix.plugins }}_plugins-${{ matrix.config }}_config
|
||||
path: |
|
||||
${{ env.DF_FOLDER }}/dfhack-rpc.txt
|
||||
${{ env.DF_FOLDER }}/test*.json
|
||||
${{ env.DF_FOLDER }}/*.log
|
||||
@ -1,71 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import argparse
|
||||
import hashlib
|
||||
import hmac
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import uuid
|
||||
|
||||
import requests
|
||||
|
||||
logging.basicConfig(level=logging.DEBUG)
|
||||
|
||||
|
||||
def get_required_env(name):
|
||||
value = os.environ.get(name)
|
||||
if not value:
|
||||
raise ValueError(f'Expected environment variable {name!r} to be non-empty')
|
||||
return value
|
||||
|
||||
|
||||
def make_sig(body, secret, algorithm):
|
||||
return hmac.new(secret.encode(), body.encode(), algorithm).hexdigest()
|
||||
|
||||
|
||||
webhook_url = get_required_env('DFHACK_BUILDMASTER_WEBHOOK_URL')
|
||||
secret = get_required_env('DFHACK_BUILDMASTER_WEBHOOK_SECRET')
|
||||
api_token = get_required_env('GITHUB_TOKEN')
|
||||
repo = get_required_env('GITHUB_REPO')
|
||||
|
||||
|
||||
parser = argparse.ArgumentParser()
|
||||
target_group = parser.add_mutually_exclusive_group(required=True)
|
||||
target_group.add_argument('--pull-request', type=int, help='Pull request to rebuild')
|
||||
args = parser.parse_args()
|
||||
|
||||
|
||||
response = requests.get(
|
||||
f'https://api.github.com/repos/{repo}/pulls/{args.pull_request}',
|
||||
headers={
|
||||
'Authorization': f'Bearer {api_token}',
|
||||
},
|
||||
)
|
||||
response.raise_for_status()
|
||||
pull_request_data = response.json()
|
||||
|
||||
|
||||
body = json.dumps({
|
||||
'action': 'synchronize',
|
||||
'number': args.pull_request,
|
||||
'pull_request': pull_request_data,
|
||||
})
|
||||
|
||||
response = requests.post(
|
||||
'https://lubar-webhook-proxy.appspot.com/github/buildmaster',
|
||||
headers={
|
||||
'Content-Type': 'application/json',
|
||||
'User-Agent': 'GitHub-Hookshot/' + requests.utils.default_user_agent(),
|
||||
'X-GitHub-Delivery': 'dfhack-rebuild-' + str(uuid.uuid4()),
|
||||
'X-GitHub-Event': 'pull_request',
|
||||
'X-Hub-Signature': 'sha1=' + make_sig(body, secret, hashlib.sha1),
|
||||
'X-Hub-Signature-256': 'sha256=' + make_sig(body, secret, hashlib.sha256),
|
||||
},
|
||||
data=body,
|
||||
timeout=15,
|
||||
)
|
||||
|
||||
print(response)
|
||||
print(str(response.text))
|
||||
response.raise_for_status()
|
||||
@ -1,52 +1,53 @@
|
||||
#!/bin/sh
|
||||
|
||||
DF_FOLDER=$1
|
||||
OS_TARGET=$2
|
||||
DF_VERSION=$3
|
||||
|
||||
set -e
|
||||
|
||||
df_tardest="df.tar.bz2"
|
||||
save_tardest="test_save.tgz"
|
||||
|
||||
cd "$(dirname "$0")"
|
||||
echo "DF_VERSION: $DF_VERSION"
|
||||
echo "DF_FOLDER: $DF_FOLDER"
|
||||
mkdir -p "$DF_FOLDER"
|
||||
# back out of df_linux
|
||||
cd "$DF_FOLDER/.."
|
||||
|
||||
if ! test -f "$df_tardest"; then
|
||||
minor=$(echo "$DF_VERSION" | cut -d. -f2)
|
||||
patch=$(echo "$DF_VERSION" | cut -d. -f3)
|
||||
echo "Downloading DF $DF_VERSION"
|
||||
while read url; do
|
||||
echo "Attempting download: ${url}"
|
||||
if wget -v "$url" -O "$df_tardest"; then
|
||||
break
|
||||
fi
|
||||
done <<URLS
|
||||
https://www.bay12games.com/dwarves/df_${minor}_${patch}_linux.tar.bz2
|
||||
https://files.dfhack.org/DF/${minor}.${patch}/df_${minor}_${patch}_linux.tar.bz2
|
||||
URLS
|
||||
echo $df_tardest
|
||||
if ! test -f "$df_tardest"; then
|
||||
echo "DF failed to download: $df_tardest not found"
|
||||
minor=$(echo "$DF_VERSION" | cut -d. -f1)
|
||||
patch=$(echo "$DF_VERSION" | cut -d. -f2)
|
||||
df_url="https://www.bay12games.com/dwarves/df_${minor}_${patch}"
|
||||
if test "$OS_TARGET" = "windows"; then
|
||||
WGET="C:/msys64/usr/bin/wget.exe"
|
||||
df_url="${df_url}_win_s.zip"
|
||||
df_archive_name="df.zip"
|
||||
df_extract_cmd="unzip -d ${DF_FOLDER}"
|
||||
elif test "$OS_TARGET" = "ubuntu"; then
|
||||
WGET=wget
|
||||
df_url="${df_url}_linux.tar.bz2"
|
||||
df_archive_name="df.tar.bz2"
|
||||
df_extract_cmd="tar -x -j -C ${DF_FOLDER} -f"
|
||||
else
|
||||
echo "Unhandled OS target: ${OS_TARGET}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! $WGET -v "$df_url" -O "$df_archive_name"; then
|
||||
echo "Failed to download DF from $df_url"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
md5sum "$df_archive_name"
|
||||
|
||||
echo "Downloading test save"
|
||||
#test_save_url="https://files.dfhack.org/DF/0.${minor}.${patch}/test_save.tgz"
|
||||
test_save_url="https://drive.google.com/uc?export=download&id=1XvYngl-DFONiZ9SD9OC4B2Ooecu8rPFz"
|
||||
if ! wget -v "$test_save_url" -O "$save_tardest"; then
|
||||
echo "failed to download test save"
|
||||
save_url="https://dffd.bay12games.com/download.php?id=15434&f=dreamfort.7z"
|
||||
save_archive_name="test_save.7z"
|
||||
save_extract_cmd="7z x -o${DF_FOLDER}/save"
|
||||
|
||||
if ! $WGET -v "$save_url" -O "$save_archive_name"; then
|
||||
echo "Failed to download test save from $save_url"
|
||||
exit 1
|
||||
fi
|
||||
echo $save_tardest
|
||||
fi
|
||||
|
||||
rm -rf df_linux
|
||||
mkdir -p df_linux/save
|
||||
md5sum "$save_archive_name"
|
||||
|
||||
echo Extracting
|
||||
tar xf "$df_tardest" --strip-components=1 -C df_linux
|
||||
tar xf "$save_tardest" -C df_linux/save
|
||||
mkdir -p ${DF_FOLDER}
|
||||
$df_extract_cmd "$df_archive_name"
|
||||
$save_extract_cmd "$save_archive_name"
|
||||
mv ${DF_FOLDER}/save/* ${DF_FOLDER}/save/region1
|
||||
|
||||
echo Done
|
||||
|
||||
ls -l
|
||||
|
||||
|
Before Width: | Height: | Size: 997 B After Width: | Height: | Size: 997 B |
Binary file not shown.
|
After Width: | Height: | Size: 5.0 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 615 B |
Binary file not shown.
|
After Width: | Height: | Size: 5.1 KiB |
|
Can't render this file because it has a wrong number of fields in line 53.
|
@ -1 +1 @@
|
||||
Subproject commit d5e17c6012e7eefb0cbe3e130a56c24bd11f0094
|
||||
Subproject commit 8cf949340e22001bee1ca25c9d6c1d6a89e8faf2
|
||||
@ -1 +1 @@
|
||||
Subproject commit 081249cceb59adc857a72d67e60c32047680f787
|
||||
Subproject commit fc4a77ea28eb5eba0ecd11443f291335ec3d2aa0
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 3.3 KiB After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.4 KiB |
@ -0,0 +1,115 @@
|
||||
burrow
|
||||
======
|
||||
|
||||
.. dfhack-tool::
|
||||
:summary: Quickly adjust burrow tiles and units.
|
||||
:tags: fort auto design productivity units
|
||||
|
||||
This tool has two modes. When enabled, it monitors burrows with names that end
|
||||
in ``+``. If a wall at the edge of such a burrow is dug out, the burrow will be
|
||||
automatically extended to include the newly-revealed adjacent walls. If a miner
|
||||
digs into an open space, such as a cavern, the open space will *not* be
|
||||
included in the burrow.
|
||||
|
||||
When run as a command, it can quickly adjust which tiles and/or units are
|
||||
associated with the burrow.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
::
|
||||
|
||||
enable burrow
|
||||
burrow tiles|units clear <target burrow> [<target burrow> ...] [<options>]
|
||||
burrow tiles|units set|add|remove <target burrow> <burrow> [...] [<options>]
|
||||
burrow tiles box-add|box-remove <target burrow> [<pos>] [<pos>] [<options>]
|
||||
burrow tiles flood-add|flood-remove <target burrow> [<options>]
|
||||
|
||||
The burrows can be referenced by name or by the internal numeric burrow ID. If
|
||||
referenced by name, the first burrow that matches the name (case sensitive)
|
||||
will be targeted. If a burrow name ends in ``+`` (to indicate that it should be
|
||||
auto-expanded), the final ``+`` does not need to be specified on the
|
||||
commandline.
|
||||
|
||||
For ``set``, ``add``, or ``remove`` commands, instead of a burrow, you can
|
||||
specify one of the following all-caps keywords:
|
||||
|
||||
- ``ABOVE_GROUND``
|
||||
- ``SUBTERRANEAN``
|
||||
- ``INSIDE``
|
||||
- ``OUTSIDE``
|
||||
- ``LIGHT``
|
||||
- ``DARK``
|
||||
- ``HIDDEN``
|
||||
- ``REVEALED``
|
||||
|
||||
to add or remove tiles with the corresponding properties.
|
||||
|
||||
Flood fill selects tiles spreading out from a starting tile if they:
|
||||
|
||||
- match the inside/outside and hidden/revealed properties of the starting tile
|
||||
- match the walkability group of the starting tile OR (if the starting tile is
|
||||
walkable) is adjacent to a tile with the same walkability group as the
|
||||
starting tile
|
||||
|
||||
When flood adding, the flood fill will also stop at any tiles that have already
|
||||
been added to the burrow. Similarly for flood removing, the flood will also
|
||||
stop at tiles that are not in the burrow.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
``enable burrow``
|
||||
Start monitoring burrows that have names ending in '+' and automatically
|
||||
expand them when walls that border the burrows are dug out.
|
||||
``burrow tiles clear Safety``
|
||||
Remove all tiles from the burrow named ``Safety`` (in preparation for
|
||||
adding new tiles elsewhere, presumably).
|
||||
``burrow units clear Farmhouse Workshops``
|
||||
Remove all units from the burrows named ``Farmhouse`` and ``Workshops``.
|
||||
``multicmd burrow tiles set Inside INSIDE; burrow tiles remove Inside HIDDEN``
|
||||
Reset the burrow named ``Inside`` to include all the currently revealed,
|
||||
interior tiles.
|
||||
``burrow units set "Core Fort" Peasants Skilled``
|
||||
Clear all units from the burrow named ``Core Fort``, then add units
|
||||
currently assigned to the ``Peasants`` and ``Skilled`` burrows.
|
||||
``burrow tiles box-add Safety 0,0,0``
|
||||
Add all tiles to the burrow named ``Safety`` that are within the volume of
|
||||
the box starting at coordinate 0, 0, 0 (the upper left corner of the bottom
|
||||
level) and ending at the current location of the keyboard cursor.
|
||||
``burrow tiles flood-add Safety --cur-zlevel``
|
||||
Flood-add the tiles on the current z-level with the same properties as the
|
||||
tile under the keyboard cursor to the burrow named ``Safety``.
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
``-c``, ``--cursor <pos>``
|
||||
Indicate the starting position of the box or flood fill. If not specified,
|
||||
the position of the keyboard cursor is used.
|
||||
``-z``, ``--cur-zlevel``
|
||||
Restricts a flood fill operation to the currently visible z-level.
|
||||
|
||||
Note
|
||||
----
|
||||
|
||||
If you are auto-expanding a burrow (whose name ends in a ``+``) and the miner
|
||||
who is digging to expand the burrow is assigned to that burrow, then 1-wide
|
||||
corridors that expand the burrow will have very slow progress. This is because
|
||||
the burrow is expanded to include the next dig job only after the miner has
|
||||
chosen a next tile to dig, which may be far away. 2-wide cooridors are much
|
||||
more efficient when expanding a burrow since the "next" tile to dig will still
|
||||
be nearby.
|
||||
|
||||
Overlay
|
||||
-------
|
||||
|
||||
When painting burrows in the vanilla UI, a few extra mouse operations are
|
||||
supported. If you box select across multiple z-levels, you will be able to
|
||||
select the entire volume instead of just the selected area on the z-level that
|
||||
you are currently looking at.
|
||||
|
||||
In addition, double-clicking will start a flood fill from the target tile.
|
||||
|
||||
The box and flood fill actions respect the UI setting for whether the burrow is
|
||||
being added to or erased.
|
||||
@ -1,54 +0,0 @@
|
||||
burrows
|
||||
=======
|
||||
|
||||
.. dfhack-tool::
|
||||
:summary: Auto-expand burrows as you dig.
|
||||
:tags: unavailable fort auto design productivity map units
|
||||
:no-command:
|
||||
|
||||
.. dfhack-command:: burrow
|
||||
:summary: Quickly add units/tiles to burrows.
|
||||
|
||||
When a wall inside a burrow with a name ending in ``+`` is dug out, the burrow
|
||||
will be extended to newly-revealed adjacent walls.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
``burrow enable auto-grow``
|
||||
When a wall inside a burrow with a name ending in '+' is dug out, the burrow
|
||||
will be extended to newly-revealed adjacent walls. This final '+' may be
|
||||
omitted in burrow name args of other ``burrow`` commands. Note that digging
|
||||
1-wide corridors with the miner inside the burrow is SLOW.
|
||||
``burrow disable auto-grow``
|
||||
Disables auto-grow processing.
|
||||
``burrow clear-unit <burrow> [<burrow> ...]``
|
||||
Remove all units from the named burrows.
|
||||
``burrow clear-tiles <burrow> [<burrow> ...]``
|
||||
Remove all tiles from the named burrows.
|
||||
``burrow set-units target-burrow <burrow> [<burrow> ...]``
|
||||
Clear all units from the target burrow, then add units from the named source
|
||||
burrows.
|
||||
``burrow add-units target-burrow <burrow> [<burrow> ...]``
|
||||
Add units from the source burrows to the target.
|
||||
``burrow remove-units target-burrow <burrow> [<burrow> ...]``
|
||||
Remove units in source burrows from the target.
|
||||
``burrow set-tiles target-burrow <burrow> [<burrow> ...]``
|
||||
Clear target burrow tiles and add tiles from the names source burrows.
|
||||
``burrow add-tiles target-burrow <burrow> [<burrow> ...]``
|
||||
Add tiles from the source burrows to the target.
|
||||
``burrow remove-tiles target-burrow <burrow> [<burrow> ...]``
|
||||
Remove tiles in source burrows from the target.
|
||||
|
||||
In place of a source burrow, you can use one of the following keywords:
|
||||
|
||||
- ``ABOVE_GROUND``
|
||||
- ``SUBTERRANEAN``
|
||||
- ``INSIDE``
|
||||
- ``OUTSIDE``
|
||||
- ``LIGHT``
|
||||
- ``DARK``
|
||||
- ``HIDDEN``
|
||||
- ``REVEALED``
|
||||
|
||||
to add tiles with the given properties.
|
||||
@ -0,0 +1,10 @@
|
||||
design
|
||||
======
|
||||
|
||||
.. dfhack-tool::
|
||||
:summary: Draws designations in shapes.
|
||||
:tags: fort design dev map
|
||||
:no-command:
|
||||
|
||||
This plugin provides a Lua API, but no direct commands. See `gui/design` for
|
||||
the user interface.
|
||||
@ -0,0 +1,23 @@
|
||||
preserve-tombs
|
||||
==============
|
||||
|
||||
.. dfhack-tool::
|
||||
:summary: Preserve tomb assignments when assigned units die.
|
||||
:tags: fort bugfix
|
||||
|
||||
If you find that the tombs you assign to units get unassigned from them when
|
||||
they die (e.g. your nobles), this tool can help fix that.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
``enable preserve-tombs``
|
||||
enable the plugin
|
||||
``preserve-tombs [status]``
|
||||
check the status of the plugin, and if the plugin is enabled,
|
||||
lists all currently tracked tomb assignments
|
||||
``preserve-tombs now``
|
||||
forces an immediate update of the tomb assignments. This plugin
|
||||
automatically updates the tomb assignments once every 100 ticks.
|
||||
|
||||
This tool runs in the background.
|
||||
@ -1,52 +0,0 @@
|
||||
.. _search-plugin:
|
||||
|
||||
search
|
||||
======
|
||||
|
||||
.. dfhack-tool::
|
||||
:summary: Adds search capabilities to the UI.
|
||||
:tags: unavailable fort productivity interface
|
||||
:no-command:
|
||||
|
||||
Search options are added to the Stocks, Animals, Trading, Stockpile, Noble
|
||||
assignment candidates), Military (position candidates), Burrows (unit list),
|
||||
Rooms, Announcements, Job List, and Unit List screens all get hotkeys that allow
|
||||
you to dynamically filter the displayed lists.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
::
|
||||
|
||||
enable search
|
||||
|
||||
.. image:: ../images/search.png
|
||||
|
||||
Searching works the same way as the search option in :guilabel:`Move to Depot`.
|
||||
You will see the Search option displayed on screen with a hotkey
|
||||
(usually :kbd:`s`). Pressing it lets you start typing a query and the relevant
|
||||
list will start filtering automatically.
|
||||
|
||||
Pressing :kbd:`Enter`, :kbd:`Esc` or the arrow keys will return you to browsing
|
||||
the now filtered list, which still functions as normal. You can clear the filter
|
||||
by either going back into search mode and backspacing to delete it, or pressing
|
||||
the "shifted" version of the search hotkey while browsing the list (e.g. if the
|
||||
hotkey is :kbd:`s`, then hitting :kbd:`Shift`:kbd:`s` will clear any filter).
|
||||
|
||||
Leaving any screen automatically clears the filter.
|
||||
|
||||
In the Trade screen, the actual trade will always only act on items that are
|
||||
actually visible in the list; the same effect applies to the Trade Value numbers
|
||||
displayed by the screen. Because of this, the :kbd:`t` key is blocked while
|
||||
search is active, so you have to reset the filters first. Pressing
|
||||
:kbd:`Alt`:kbd:`C` will clear both search strings.
|
||||
|
||||
In the stockpile screen the option only appears if the cursor is in the
|
||||
rightmost list:
|
||||
|
||||
.. image:: ../images/search-stockpile.png
|
||||
|
||||
Note that the 'Permit XXX'/'Forbid XXX' keys conveniently operate only on items
|
||||
actually shown in the rightmost list, so it is possible to select only fat or
|
||||
tallow by forbidding fats, then searching for fat/tallow, and using Permit Fats
|
||||
again while the list is filtered.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue