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

Merge pull request #4013 from myk002/myk_av_help 

add guidance for installing on windows
develop
Myk 2023-11-12 11:01:52 -08:00 committed by GitHub
parent f17e5c3fa0 32ed6d6bcd
commit 38d8ec48e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/release_template.md vendored
Unescape Escape View File

@ -1,5 +1,5 @@
#### Q: How do I download DFHack? #### 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.
------------- -------------

8
docs/Installing.rst
Unescape Escape View File

@ -31,7 +31,7 @@ Downloading DFHack
================== ==================
Stable builds of DFHack are available on Stable builds of DFHack are available on
`Steam <https://store.steampowered.com/app/2346660/DFHack__Dwarf_Fortress_Modding_Engine/>`__ `Steam <https://store.steampowered.com/app/2346660/DFHack>`__
or from our `GitHub <https://github.com/dfhack/dfhack/releases>`__. Either or from our `GitHub <https://github.com/dfhack/dfhack/releases>`__. Either
location will give you exactly the same package. location will give you exactly the same package.
@ -53,7 +53,7 @@ DF version - see `above <installing-df-version>` for details. For example:
Do *not* download the source code from GitHub, either from the releases page Do *not* download the source code from GitHub, either from the releases page
or by clicking "Download ZIP" on the repo homepage. This will give you an or by clicking "Download ZIP" on the repo homepage. This will give you an
incomplete copy of the DFHack source code, which will not work as-is. (If incomplete copy of the DFHack source code, which will not work as-is. (If
you want to compile DFHack instead of using a pre-built release, see you want to compile DFHack instead of using a pre-built release, please see
`building-dfhack-index` for instructions.) `building-dfhack-index` for instructions.)
Beta releases Beta releases
@ -92,6 +92,10 @@ When you `download DFHack <downloading>`, you will end up with a release archive
operating system should have built-in utilities capable of extracting files from operating system should have built-in utilities capable of extracting files from
these archives. these archives.
If you are on Windows, 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.
The release archives contain a ``hack`` folder where DFHack binary and system The release archives contain a ``hack`` folder where DFHack binary and system
data is stored, a ``stonesense`` folder that contains data specific to the data is stored, a ``stonesense`` folder that contains data specific to the
`stonesense` 3d renderer, and various libraries and executable files. To `stonesense` 3d renderer, and various libraries and executable files. To