Skip to content

Commit

Permalink
add installation instructions for wineskin on mac
Browse files Browse the repository at this point in the history
  • Loading branch information
myk002 committed Jan 3, 2024
1 parent 807977f commit 2393e8f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
22 changes: 20 additions & 2 deletions docs/Installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ releases *never* support newer versions of DF -- DFHack requires data about DF
that is only possible to obtain after DF has been released. Occasionally,
DFHack releases will be able to maintain support for older versions of DF - for
example, DFHack 0.34.11-r5 supported both DF 0.34.11 and 0.34.10. For maximum
stability, you should usually use the latest versions of both DF and DFHack.
stability, you should use the latest versions of both DF and DFHack.

.. _downloading:

Expand Down Expand Up @@ -60,7 +60,8 @@ 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.
regular Github page as a pre-release tagged with a "beta" or "rc" ("release
candidate") suffix.

Development builds
------------------
Expand Down Expand Up @@ -104,6 +105,23 @@ among other things. Some redistributions of Dwarf Fortress may place DF in
another folder, so ensure that the ``hack`` folder ends up next to the ``data``
folder, and you'll be fine.

Installing into a wineskin on Mac
---------------------------------

Until DF (and DFHack) is natively available for Mac, you'll have to run the
Windows version under emulation. Here are the instructions for adding DFHack to
a wineskin that has DF installed in it:

#. Find the location of your existing Dwarf Fortress app (default is
``/user/applications/Wineskin/``). Control + click and select "Show package
contents" from the menu.
#. Find the location of the ``Dwarf Fortress`` folder inside the package
contents (default is ``/drive_c/Program Files/``)
#. Copy the contents of the unzipped DFHack folder (Windows versino) into the
``Dwarf Fortress`` folder inside the package.

These instructions were last tested on Mac Sonoma 14.1.2.

Uninstalling DFHack
===================

Expand Down
1 change: 1 addition & 0 deletions docs/changelog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ Template for new versions:
- `work-now`: now saves its enabled status with the fort

## Documentation
- `installing`: Add installation instructions for winskin on Mac
- UTF-8 text in tool docs is now properly displayed in-game in `gui/launcher` (assuming that it can be converted to cp-437)

## API
Expand Down

0 comments on commit 2393e8f

Please sign in to comment.