MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3763 from myk002/myk_dev_builds 

add instructions for downloading dev builds
develop
Myk 2023-09-11 15:07:03 -07:00 committed by GitHub
parent 6a99e97371 1032ae41fd
commit 1db67a9d98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/Installing.rst
Unescape Escape View File

@ -48,10 +48,6 @@ DF version - see `above <installing-df-version>` for details. For example:
* ``dfhack-50.07-r1-Windows-64bit.zip`` supports 64-bit DF on Windows
In between stable releases, we may create beta releases to test new features.
These are available via the beta release channel on Steam or from our regular
Github page as a pre-release tagged with a "beta" suffix.
.. warning::
Do *not* download the source code from GitHub, either from the releases page
@ -60,6 +56,31 @@ Github page as a pre-release tagged with a "beta" suffix.
you want to compile DFHack instead of using a pre-built release, see
`building-dfhack-index` for instructions.)
Beta releases
-------------
In between stable releases, we may create beta releases to test new features.
These are available via the ``beta`` release channel on Steam or from our
regular Github page as a pre-release tagged with a "beta" or "rc" suffix.
Development builds
------------------
If you are actively working with the DFHack team on testing a feature, you may
want to download and install a development build. They are available via the
``testing`` release channel on Steam or can be downloaded from the build
artifact list on GitHub for specific repository commits.
To download a development build from GitHub:
- Ensure you are logged into your GitHub account
- Go to https://github.com/DFHack/dfhack/actions/workflows/build.yml?query=branch%3Adevelop+event%3Apush
- Click on the first entry that has a green checkmark
- Click the number under "Artifacts" (or scroll down)
- Click on the "dfhack-*-build-*" artifact for your platform to download
You can extract this package the same as if you are doing a manual install (see the next section).
Installing DFHack
=================

1
docs/changelog.txt
Unescape Escape View File

@ -67,6 +67,7 @@ Template for new versions:
- `sort`: display a rating relative to the current sort order next to the visible units on the squad assignment screen
## Documentation
- add instructions for downloading development builds to the ``Installing`` page
## API
- `overlay`: overlay widgets can now declare a ``version`` attribute. changing the version of a widget will reset its settings to defaults. this is useful when changing the overlay layout and old saved positions will no longer be valid.