From 32ed6d6bcd470ee5a8bc9fbe68eb399e891b53bd Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Sun, 12 Nov 2023 01:47:44 -0800 Subject: [PATCH] add guidance for installing on windows to help avoid issues with antivirus --- .github/release_template.md | 2 +- docs/Installing.rst | 8 ++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/release_template.md b/.github/release_template.md index 5ca0a1983..6e9d068cc 100644 --- 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. ------------- diff --git a/docs/Installing.rst b/docs/Installing.rst index 14b5a0f93..b21568815 100644 --- a/docs/Installing.rst +++ b/docs/Installing.rst @@ -31,7 +31,7 @@ Downloading DFHack ================== Stable builds of DFHack are available on -`Steam `__ +`Steam `__ or from our `GitHub `__. Either location will give you exactly the same package. @@ -53,7 +53,7 @@ DF version - see `above ` for details. For example: 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 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.) Beta releases @@ -92,6 +92,10 @@ When you `download DFHack `, you will end up with a release archive operating system should have built-in utilities capable of extracting files from 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 data is stored, a ``stonesense`` folder that contains data specific to the `stonesense` 3d renderer, and various libraries and executable files. To