Merge remote-tracking branch 'DFHack/develop' into develop
Rose
commit
1808cfc51b
@ -1,869 +0,0 @@
|
||||
.. highlight:: shell
|
||||
|
||||
.. _compile:
|
||||
|
||||
################
|
||||
Compiling DFHack
|
||||
################
|
||||
|
||||
DFHack builds are available for all supported platforms; see `installing` for
|
||||
installation instructions. If you are a DFHack end-user, modder, or plan on
|
||||
writing scripts (not plugins), it is generally recommended (and easier) to use
|
||||
these builds instead of compiling DFHack from source.
|
||||
|
||||
However, if you are looking to develop plugins, work on the DFHack core, make
|
||||
complex changes to DF-structures, or anything else that requires compiling
|
||||
DFHack from source, this document will walk you through the build process. Note
|
||||
that some steps may be unconventional compared to other projects, so be sure to
|
||||
pay close attention if this is your first time compiling DFHack.
|
||||
|
||||
.. contents:: Contents
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
.. _compile-how-to-get-the-code:
|
||||
|
||||
How to get the code
|
||||
===================
|
||||
DFHack uses Git for source control; instructions for installing Git can be found
|
||||
in the platform-specific sections below. The code is hosted on
|
||||
`GitHub <https://github.com/DFHack/dfhack>`_, and can be downloaded with::
|
||||
|
||||
git clone --recursive https://github.com/DFHack/dfhack
|
||||
cd dfhack
|
||||
|
||||
If your version of Git does not support the ``--recursive`` flag, you will need
|
||||
to omit it and run ``git submodule update --init`` after entering the dfhack
|
||||
directory.
|
||||
|
||||
This will check out the code on the default branch of the GitHub repo, currently
|
||||
``develop``, which may be unstable. If you want code for the latest stable
|
||||
release, you can check out the ``master`` branch instead::
|
||||
|
||||
git checkout master
|
||||
git submodule update
|
||||
|
||||
In general, a single DFHack clone is suitable for development - most Git
|
||||
operations such as switching branches can be done on an existing clone. If you
|
||||
find yourself cloning DFHack frequently as part of your development process, or
|
||||
getting stuck on anything else Git-related, feel free to reach out to us for
|
||||
assistance.
|
||||
|
||||
.. admonition:: Offline builds
|
||||
|
||||
If you plan to build DFHack on a machine without an internet connection (or
|
||||
with an unreliable connection), see `note-offline-builds` for additional
|
||||
instructions.
|
||||
|
||||
.. admonition:: Working with submodules
|
||||
|
||||
DFHack uses submodules extensively to manage its subprojects (including the
|
||||
``scripts`` folder and DF-structures in ``library/xml``). Failing to keep
|
||||
submodules in sync when switching between branches can result in build errors
|
||||
or scripts that don't work. In general, you should always update submodules
|
||||
whenever you switch between branches in the main DFHack repo with
|
||||
``git submodule update``. (If you are working on bleeding-edge DFHack and
|
||||
have checked out the master branch of some submodules, running ``git pull``
|
||||
in those submodules is also an option.)
|
||||
|
||||
Rarely, we add or remove submodules. If there are any changes to the existence
|
||||
of submodules when you switch between branches, you should run
|
||||
``git submodule update --init`` instead (adding ``--init`` to the above
|
||||
command).
|
||||
|
||||
Some common errors that can arise when failing to update submodules include:
|
||||
|
||||
* ``fatal: <some path> does not exist`` when performing Git operations
|
||||
* Build errors, particularly referring to structures in the ``df::`` namespace
|
||||
or the ``library/include/df`` folder
|
||||
* ``Not a known DF version`` when starting DF
|
||||
* ``Run 'git submodule update --init'`` when running CMake
|
||||
|
||||
Submodules are a particularly confusing feature of Git. The
|
||||
`Git Book <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_ has a
|
||||
thorough explanation of them (as well as of many other aspects of Git) and
|
||||
is a recommended resource if you run into any issues. Other DFHack developers
|
||||
are also able to help with any submodule-related (or Git-related) issues
|
||||
you may encounter.
|
||||
|
||||
|
||||
Contributing to DFHack
|
||||
----------------------
|
||||
|
||||
For details on contributing to DFHack, including pull requests, code
|
||||
format, and more, please see `contributing-code`.
|
||||
|
||||
|
||||
Build settings
|
||||
==============
|
||||
|
||||
This section describes build configuration options that apply to all platforms.
|
||||
If you don't have a working build environment set up yet, follow the instructions
|
||||
in the platform-specific sections below first, then come back here.
|
||||
|
||||
Generator
|
||||
---------
|
||||
|
||||
The ``Ninja`` CMake build generator is the preferred build method on Linux and
|
||||
macOS, instead of ``Unix Makefiles``, which is the default. You can select Ninja
|
||||
by passing ``-G Ninja`` to CMake. Incremental builds using Unix Makefiles can be
|
||||
much slower than Ninja builds. Note that you will probably need to install
|
||||
Ninja; see the platform-specific sections for details.
|
||||
|
||||
::
|
||||
|
||||
cmake .. -G Ninja
|
||||
|
||||
.. warning::
|
||||
|
||||
Most other CMake settings can be changed by running ``cmake`` again, but the
|
||||
generator cannot be changed after ``cmake`` has been run without creating a
|
||||
new build folder. Do not forget to specify this option.
|
||||
|
||||
CMake versions 3.6 and older, and possibly as recent as 3.9, are known to
|
||||
produce project files with dependency cycles that fail to build
|
||||
(see :issue:`1369`). Obtaining a recent version of CMake is recommended, either from
|
||||
`cmake.org <https://cmake.org/download/>`_ or through a package manager. See
|
||||
the sections below for more platform-specific directions for installing CMake.
|
||||
|
||||
Build type
|
||||
----------
|
||||
|
||||
``cmake`` allows you to pick a build type by changing the ``CMAKE_BUILD_TYPE`` variable::
|
||||
|
||||
cmake .. -DCMAKE_BUILD_TYPE:string=BUILD_TYPE
|
||||
|
||||
Valid and useful build types include 'Release' and 'RelWithDebInfo'. The default
|
||||
build type is 'Release'.
|
||||
|
||||
Target architecture (32-bit vs. 64-bit)
|
||||
---------------------------------------
|
||||
|
||||
Set DFHACK_BUILD_ARCH to either ``32`` or ``64`` to build a 32-bit or 64-bit
|
||||
version of DFHack (respectively). The default is currently ``64``, so you will
|
||||
need to specify this explicitly for 32-bit builds. Specifying it is a good idea
|
||||
in any case.
|
||||
|
||||
::
|
||||
|
||||
cmake .. -DDFHACK_BUILD_ARCH=32
|
||||
|
||||
*or*
|
||||
::
|
||||
|
||||
cmake .. -DDFHACK_BUILD_ARCH=64
|
||||
|
||||
Note that the scripts in the "build" folder on Windows will set the architecture
|
||||
automatically.
|
||||
|
||||
.. _compile-build-options:
|
||||
|
||||
Other settings
|
||||
--------------
|
||||
There are a variety of other settings which you can find in CMakeCache.txt in
|
||||
your build folder or by running ``ccmake`` (or another CMake GUI). Most
|
||||
DFHack-specific settings begin with ``BUILD_`` and control which parts of DFHack
|
||||
are built.
|
||||
|
||||
|
||||
.. _compile-linux:
|
||||
|
||||
Linux
|
||||
=====
|
||||
On Linux, DFHack acts as a library that shadows parts of the SDL API using LD_PRELOAD.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
DFHack is meant to be installed into an existing DF folder, so get one ready.
|
||||
|
||||
We assume that any Linux platform will have ``git`` available (though it may
|
||||
need to be installed with your package manager.)
|
||||
|
||||
To build DFHack, you need GCC 4.8 or newer. GCC 4.8 has the benefit of avoiding
|
||||
`libstdc++ compatibility issues <linux-incompatible-libstdcxx>`, but can be hard
|
||||
to obtain on modern distributions, and working around these issues is done
|
||||
automatically by the ``dfhack`` launcher script. As long as your system-provided
|
||||
GCC is new enough, it should work. Note that extremely new GCC versions may not
|
||||
have been used to build DFHack yet, so if you run into issues with these, please
|
||||
let us know (e.g. by opening a GitHub issue).
|
||||
|
||||
Before you can build anything, you'll also need ``cmake``. It is advisable to
|
||||
also get ``ccmake`` on distributions that split the cmake package into multiple
|
||||
parts. As mentioned above, ``ninja`` is recommended (many distributions call
|
||||
this package ``ninja-build``).
|
||||
|
||||
You will need pthread; most systems should have this already. Note that older
|
||||
CMake versions may have trouble detecting pthread, so if you run into
|
||||
pthread-related errors and pthread is installed, you may need to upgrade CMake,
|
||||
either by downloading it from `cmake.org <https://cmake.org/download/>`_ or
|
||||
through your package manager, if possible.
|
||||
|
||||
You also need zlib, libsdl (1.2, not sdl2, like DF), perl, and the XML::LibXML
|
||||
and XML::LibXSLT perl packages (for the code generation parts). You should be
|
||||
able to find them in your distribution's repositories.
|
||||
|
||||
To build `stonesense`, you'll also need OpenGL headers.
|
||||
|
||||
Here are some package install commands for various distributions:
|
||||
|
||||
* On Arch linux:
|
||||
|
||||
* For the required Perl modules: ``perl-xml-libxml`` and ``perl-xml-libxslt`` (or through ``cpan``)
|
||||
|
||||
* On Ubuntu::
|
||||
|
||||
apt-get install gcc cmake ninja-build git zlib1g-dev libsdl1.2-dev libxml-libxml-perl libxml-libxslt-perl
|
||||
|
||||
* Other Debian-based distributions should have similar requirements.
|
||||
|
||||
* On Fedora::
|
||||
|
||||
yum install gcc-c++ cmake ninja-build git zlib-devel SDL-devel perl-core perl-XML-LibXML perl-XML-LibXSLT ruby
|
||||
|
||||
|
||||
Multilib dependencies
|
||||
---------------------
|
||||
If you want to compile 32-bit DFHack on 64-bit distributions, you'll need the
|
||||
multilib development tools and libraries:
|
||||
|
||||
* ``gcc-multilib`` and ``g++-multilib``
|
||||
* If you have installed a non-default version of GCC - for example, GCC 4.8 on a
|
||||
distribution that defaults to 5.x - you may need to add the version number to
|
||||
the multilib packages.
|
||||
|
||||
* For example, ``gcc-4.8-multilib`` and ``g++-4.8-multilib`` if installing for GCC 4.8
|
||||
on a system that uses a later GCC version.
|
||||
* This is definitely required on Ubuntu/Debian, check if using a different distribution.
|
||||
|
||||
* ``zlib1g-dev:i386`` (or a similar i386 zlib-dev package)
|
||||
|
||||
Note that installing a 32-bit GCC on 64-bit systems (e.g. ``gcc:i386`` on
|
||||
Debian) will typically *not* work, as it depends on several other 32-bit
|
||||
libraries that conflict with system libraries. Alternatively, you might be able
|
||||
to use ``lxc`` to
|
||||
:forums:`create a virtual 32-bit environment <139553.msg5435310#msg5435310>`.
|
||||
|
||||
Build
|
||||
-----
|
||||
Building is fairly straightforward. Enter the ``build`` folder (or create an
|
||||
empty folder in the DFHack directory to use instead) and start the build like this::
|
||||
|
||||
cd build
|
||||
cmake .. -G Ninja -DCMAKE_BUILD_TYPE:string=Release -DCMAKE_INSTALL_PREFIX=<path to DF>
|
||||
ninja install # or ninja -jX install to specify the number of cores (X) to use
|
||||
|
||||
<path to DF> should be a path to a copy of Dwarf Fortress, of the appropriate
|
||||
version for the DFHack you are building. This will build the library along
|
||||
with the normal set of plugins and install them into your DF folder.
|
||||
|
||||
Alternatively, you can use ccmake instead of cmake::
|
||||
|
||||
cd build
|
||||
ccmake .. -G Ninja
|
||||
ninja install
|
||||
|
||||
This will show a curses-based interface that lets you set all of the
|
||||
extra options. You can also use a cmake-friendly IDE like KDevelop 4
|
||||
or the cmake-gui program.
|
||||
|
||||
.. _linux-incompatible-libstdcxx:
|
||||
|
||||
Incompatible libstdc++
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
When compiling DFHack yourself, it builds against your system libstdc++. When
|
||||
Dwarf Fortress runs, it uses a libstdc++ shipped in the ``libs`` folder, which
|
||||
comes from GCC 4.8 and is incompatible with code compiled with newer GCC
|
||||
versions. As of DFHack 0.42.05-alpha1, the ``dfhack`` launcher script attempts
|
||||
to fix this by automatically removing the DF-provided libstdc++ on startup.
|
||||
In rare cases, this may fail and cause errors such as:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
./libs/Dwarf_Fortress: /pathToDF/libs/libstdc++.so.6: version
|
||||
`GLIBCXX_3.4.18' not found (required by ./hack/libdfhack.so)
|
||||
|
||||
The easiest way to fix this is generally removing the libstdc++ shipped with
|
||||
DF, which causes DF to use your system libstdc++ instead::
|
||||
|
||||
cd /path/to/DF/
|
||||
rm libs/libstdc++.so.6
|
||||
|
||||
Note that distributing binaries compiled with newer GCC versions may result in
|
||||
the opposite compatibility issue: users with *older* GCC versions may encounter
|
||||
similar errors. This is why DFHack distributes both GCC 4.8 and GCC 7 builds. If
|
||||
you are planning on distributing binaries to other users, we recommend using an
|
||||
older GCC (but still at least 4.8) version if possible.
|
||||
|
||||
|
||||
.. _compile-macos:
|
||||
|
||||
macOS
|
||||
=====
|
||||
DFHack functions similarly on macOS and Linux, and the majority of the
|
||||
information above regarding the build process (CMake and Ninja) applies here
|
||||
as well.
|
||||
|
||||
DFHack can officially be built on macOS only with GCC 4.8 or 7. Anything newer than 7
|
||||
will require you to perform extra steps to get DFHack to run (see `osx-new-gcc-notes`),
|
||||
and your build will likely not be redistributable.
|
||||
|
||||
.. _osx-new-gcc-notes:
|
||||
|
||||
Notes for GCC 8+ or OS X 10.10+ users
|
||||
-------------------------------------
|
||||
|
||||
If none of these situations apply to you, skip to `osx-setup`.
|
||||
|
||||
If you have issues building on OS X 10.10 (Yosemite) or above, try defining
|
||||
the following environment variable::
|
||||
|
||||
export MACOSX_DEPLOYMENT_TARGET=10.9
|
||||
|
||||
If you build with a GCC version newer than 7, DFHack will probably crash
|
||||
immediately on startup, or soon after. To fix this, you will need to replace
|
||||
``hack/libstdc++.6.dylib`` with a symlink to the ``libstdc++.6.dylib`` included
|
||||
in your version of GCC::
|
||||
|
||||
cd <path to df>/hack && mv libstdc++.6.dylib libstdc++.6.dylib.orig &&
|
||||
ln -s [PATH_TO_LIBSTDC++] .
|
||||
|
||||
For example, with GCC 6.3.0, ``PATH_TO_LIBSTDC++`` would be::
|
||||
|
||||
/usr/local/Cellar/gcc@6/6.3.0/lib/gcc/6/libstdc++.6.dylib # for 64-bit DFHack
|
||||
/usr/local/Cellar/gcc@6/6.3.0/lib/gcc/6/i386/libstdc++.6.dylib # for 32-bit DFHack
|
||||
|
||||
**Note:** If you build with a version of GCC that requires this, your DFHack
|
||||
build will *not* be redistributable. (Even if you copy the ``libstdc++.6.dylib``
|
||||
from your GCC version and distribute that too, it will fail on older OS X
|
||||
versions.) For this reason, if you plan on distributing DFHack, it is highly
|
||||
recommended to use GCC 4.8 or 7.
|
||||
|
||||
.. _osx-m1-notes:
|
||||
|
||||
Notes for M1 users
|
||||
------------------
|
||||
|
||||
Alongside the above, you will need to follow these additional steps to get it
|
||||
running on Apple silicon.
|
||||
|
||||
Install an x86 copy of ``homebrew`` alongside your existing one. `This
|
||||
stackoverflow answer <https://stackoverflow.com/a/64951025>`__ describes the
|
||||
process.
|
||||
|
||||
Follow the normal macOS steps to install ``cmake`` and ``gcc`` via your x86 copy of
|
||||
``homebrew``. Note that this will install a GCC version newer than 7, so see
|
||||
`osx-new-gcc-notes`.
|
||||
|
||||
In your terminal, ensure you have your path set to the correct homebrew in
|
||||
addition to the normal ``CC`` and ``CXX`` flags above::
|
||||
|
||||
export PATH=/usr/local/bin:$PATH
|
||||
|
||||
.. _osx-setup:
|
||||
|
||||
Dependencies and system set-up
|
||||
------------------------------
|
||||
|
||||
#. Download and unpack a copy of the latest DF
|
||||
#. Install Xcode from the Mac App Store
|
||||
|
||||
#. Install the XCode Command Line Tools by running the following command::
|
||||
|
||||
xcode-select --install
|
||||
|
||||
#. Install dependencies
|
||||
|
||||
It is recommended to use Homebrew instead of MacPorts, as it is generally
|
||||
cleaner, quicker, and smarter. For example, installing MacPort's GCC will
|
||||
install more than twice as many dependencies as Homebrew's will, and all in
|
||||
both 32-bit and 64-bit variants. Homebrew also doesn't require constant use
|
||||
of ``sudo``.
|
||||
|
||||
Using `Homebrew <https://brew.sh/>`_ (recommended)::
|
||||
|
||||
brew tap homebrew/versions
|
||||
brew install git
|
||||
brew install cmake
|
||||
brew install ninja
|
||||
brew install gcc@7
|
||||
|
||||
Using `MacPorts <https://www.macports.org>`_::
|
||||
|
||||
sudo port install gcc7 +universal cmake +universal git-core +universal ninja +universal
|
||||
|
||||
Macports will take some time - maybe hours. At some point it may ask
|
||||
you to install a Java environment; let it do so.
|
||||
|
||||
#. Install Perl dependencies
|
||||
|
||||
* Using system Perl
|
||||
|
||||
* ``sudo cpan``
|
||||
|
||||
If this is the first time you've run cpan, you will need to go through the setup
|
||||
process. Just stick with the defaults for everything and you'll be fine.
|
||||
|
||||
If you are running OS X 10.6 (Snow Leopard) or earlier, good luck!
|
||||
You'll need to open a separate Terminal window and run::
|
||||
|
||||
sudo ln -s /usr/include/libxml2/libxml /usr/include/libxml
|
||||
|
||||
* ``install XML::LibXML``
|
||||
* ``install XML::LibXSLT``
|
||||
|
||||
* In a separate, local Perl install
|
||||
|
||||
Rather than using system Perl, you might also want to consider
|
||||
the Perl manager, `Perlbrew <https://perlbrew.pl>`_.
|
||||
|
||||
This manages Perl 5 locally under ``~/perl5/``, providing an easy
|
||||
way to install Perl and run CPAN against it without ``sudo``.
|
||||
It can maintain multiple Perl installs and being local has the
|
||||
benefit of easy migration and insulation from OS issues and upgrades.
|
||||
|
||||
See https://perlbrew.pl/ for more details.
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
* Get the DFHack source as per section `compile-how-to-get-the-code`, above.
|
||||
* Set environment variables
|
||||
|
||||
Homebrew (if installed elsewhere, replace /usr/local with ``$(brew --prefix)``)::
|
||||
|
||||
export CC=/usr/local/bin/gcc-7
|
||||
export CXX=/usr/local/bin/g++-7
|
||||
|
||||
Macports::
|
||||
|
||||
export CC=/opt/local/bin/gcc-mp-7
|
||||
export CXX=/opt/local/bin/g++-mp-7
|
||||
|
||||
Change the version numbers appropriately if you installed a different version of GCC.
|
||||
|
||||
If you are confident that you have GCC in your path, you can omit the absolute paths::
|
||||
|
||||
export CC=gcc-7
|
||||
export CXX=g++-7
|
||||
|
||||
(adjust as needed for different GCC installations)
|
||||
|
||||
* Build DFHack::
|
||||
|
||||
mkdir build-osx
|
||||
cd build-osx
|
||||
cmake .. -G Ninja -DCMAKE_BUILD_TYPE:string=Release -DCMAKE_INSTALL_PREFIX=<path to DF>
|
||||
ninja install # or ninja -jX install to specify the number of cores (X) to use
|
||||
|
||||
<path to DF> should be a path to a copy of Dwarf Fortress, of the appropriate
|
||||
version for the DFHack you are building.
|
||||
|
||||
|
||||
.. _compile-windows:
|
||||
|
||||
Windows
|
||||
=======
|
||||
On Windows, DFHack replaces the SDL library distributed with DF.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
You will need the following:
|
||||
|
||||
* Microsoft Visual C++ 2022, 2019, 2017, or 2015 (optional)
|
||||
* Microsoft Visual C++ 2015 Build Tools
|
||||
* Git
|
||||
* CMake
|
||||
* Perl with XML::LibXML and XML::LibXSLT
|
||||
|
||||
* It is recommended to install StrawberryPerl, which includes both.
|
||||
|
||||
* Python (for documentation; optional, except for release builds)
|
||||
|
||||
Microsoft Visual Studio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Releases of Dwarf Fortress since roughly 2016 have been compiled for Windows using
|
||||
Microsoft's Visual Studio 2015 C++ compiler. In order to guarantee ABI and STL compatibility
|
||||
with Dwarf Fortress, DFHack has to be compiled with the same compiler.
|
||||
|
||||
Visual Studio 2015 is no longer supported by Microsoft and it can be difficult to obtain
|
||||
working installers for this product today. As of 2022, the recommended approach
|
||||
is to use Visual Studio 2022 or Visual Studio 2019, installing additional optional
|
||||
Visual Studio components which provide the required support for using
|
||||
Visual Studio 2015's toolchain. All of the required tools are available from Microsoft as part of
|
||||
Visual Studio's Community Edition at no charge.
|
||||
|
||||
You can also download just the Visual C++ 2015 `build tools`_ if you aren't going to use
|
||||
Visual Studio to edit code.
|
||||
|
||||
Option 1: Build Tools Only
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Click `build tools`_ and you will be prompted to login to your Microsoft account.
|
||||
Then you should be redirected to a page with various download options with 2015
|
||||
in their name. If this redirect doesn't occur, just copy, paste, and enter the
|
||||
download link again and you should see the options. You need to get:
|
||||
Visual C++ Build Tools for Visual Studio 2015 with Update 3.
|
||||
Click the download button next to it and a dropdown of download formats will appear.
|
||||
Select the DVD format to download an ISO file. When the download is complete,
|
||||
click on the ISO file and a folder will popup with the following contents:
|
||||
|
||||
* packages (folder)
|
||||
* VCPlusPlusBuildTools2015Update3_x64_Files.cat
|
||||
* VisualCppBuildTools_Full.exe
|
||||
|
||||
The packages folder contains the dependencies that are required by the build tools.
|
||||
These include:
|
||||
|
||||
* Microsoft .NET Framework 4.6.1 Developer Pack
|
||||
* Microsoft Visual C++ 2015 Redistributable (x64) - 14.0.24210
|
||||
* Windows 10 Universal SDK - 10.0.10240
|
||||
* Windows 8.1 SDK
|
||||
|
||||
Click VisualCppBuildTools_Full.exe and use the default options provided by the installer
|
||||
wizard that appears. After the installation is completed, add the path where MSBuild.exe
|
||||
was installed to your PATH environment variable. The path should be:
|
||||
|
||||
* ``C:\Program Files (x86)\MSBuild\14.0\Bin``
|
||||
|
||||
Note that this process may install only the ``v140`` toolchain, not the ``v140_xp`` toolchain that
|
||||
is normally used to compile build releases of DFHack. Due to a bug in the Microsoft-provided libraries used with
|
||||
the ``v140_xp`` toolchain that Microsoft has never fixed, DFHack (and probably also Dwarf Fortress itself)
|
||||
doesn't run reliably on 64-bit XP. Investigations have so far suggested that ``v140`` and
|
||||
``v140_xp`` are ABI-compatible. As such, there should be no harm in using ``v140`` instead of
|
||||
``v140_xp`` as the build toolchain, at least on 64-bit platforms. However, it is our policy to use
|
||||
``v140_xp`` for release builds for both 32-bit and 64-bit Windows,
|
||||
since 32-bit releases of Dwarf Fortress work on XP and ``v140_xp`` is required for compatibility with
|
||||
XP.
|
||||
|
||||
The ``v141`` toolchain, in Visual Studio 2017, has been empirically documented to be incompatible with
|
||||
released versions of Dwarf Fortress and cannot be used to make usable builds of DFHack.
|
||||
|
||||
Option 2: IDE + Build Tools
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Click Visual Studio 2022_ or 2019_ to download an installer wizard that will prompt you
|
||||
to select the optional tools you want to download alongside the IDE. You may need to log into
|
||||
(or create) a Microsoft account in order to download Visual Studio.
|
||||
|
||||
In addition to selecting the workload for "Desktop Development with C++",
|
||||
you will also need to go to the "Individual Components" tab in the Installer and
|
||||
select the following additional components to get the "``v140_xp``" toolchain that DFHack
|
||||
requires for ABI compatibility with recent releases of Dwarf Fortress:
|
||||
* MSVC v140 - VS 2015 C++ build tools (v14.00)
|
||||
* C++ Windows XP Support for VS 2017 (v141) tools [Deprecated]
|
||||
|
||||
Yes, this is unintuitive. Installing XP Support for VS 2017 installs XP Support for VS 2015
|
||||
if the 2015 toolchain is installed.
|
||||
|
||||
.. _2022: https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false
|
||||
.. _2019: https://my.visualstudio.com/Downloads?q=visual%20studio%202019&wt.mc_id=o~msft~vscom~older-downloads
|
||||
.. _build tools: https://my.visualstudio.com/Downloads?q=visual%20studio%202015&wt.mc_id=o~msft~vscom~older-downloads
|
||||
|
||||
Additional dependencies: installing with the Chocolatey Package Manager
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The remainder of dependencies - Git, CMake, StrawberryPerl, and Python - can be
|
||||
most easily installed using the Chocolatey Package Manager. Chocolatey is a
|
||||
\*nix-style package manager for Windows. It's fast, small (8-20MB on disk)
|
||||
and very capable. Think "``apt-get`` for Windows."
|
||||
|
||||
Chocolatey is a recommended way of installing the required dependencies
|
||||
as it's quicker, requires less effort, and will install known-good utilities
|
||||
guaranteed to have the correct setup (especially PATH).
|
||||
|
||||
To install Chocolatey and the required dependencies:
|
||||
|
||||
* Go to https://chocolatey.org in a web browser
|
||||
* At the top of the page it will give you the install command to copy
|
||||
|
||||
* Copy the first one, which starts ``@powershell ...``
|
||||
* It won't be repeated here in case it changes in future Chocolatey releases.
|
||||
|
||||
* Open an elevated (Admin) ``cmd.exe`` window
|
||||
|
||||
* On Windows 8 and later this can be easily achieved by:
|
||||
|
||||
* right-clicking on the Start Menu, or pressing Win+X.
|
||||
* choosing "Command Prompt (Admin)"
|
||||
|
||||
* On earlier Windows: find ``cmd.exe`` in Start Menu, right click
|
||||
and choose Open As Administrator.
|
||||
|
||||
* Paste in the Chocolatey install command and hit enter
|
||||
* Close this ``cmd.exe`` window and open another Admin ``cmd.exe`` in the same way
|
||||
* Run the following command::
|
||||
|
||||
choco install git cmake.portable strawberryperl -y
|
||||
|
||||
* Close the Admin ``cmd.exe`` window; you're done!
|
||||
|
||||
You can now use all of these utilities from any normal ``cmd.exe`` window.
|
||||
You only need Admin/elevated ``cmd.exe`` for running ``choco install`` commands;
|
||||
for all other purposes, including compiling DFHack, you should use
|
||||
a normal ``cmd.exe`` (or, better, an improved terminal like `Cmder <https://cmder.net/>`_;
|
||||
details below, under Build.)
|
||||
|
||||
**NOTE**: you can run the above ``choco install`` command even if you already have
|
||||
Git, CMake or StrawberryPerl installed. Chocolatey will inform you if any software
|
||||
is already installed and won't re-install it. In that case, please check the PATHs
|
||||
are correct for that utility as listed in the manual instructions below. Or, better,
|
||||
manually uninstall the version you have already and re-install via Chocolatey,
|
||||
which will ensure the PATH are set up right and will allow Chocolatey to manage
|
||||
that program for you in future.
|
||||
|
||||
Additional dependencies: installing manually
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
If you prefer to install manually rather than using Chocolatey, details and
|
||||
requirements are as below. If you do install manually, please ensure you
|
||||
have all PATHs set up correctly.
|
||||
|
||||
Git
|
||||
^^^
|
||||
Some examples:
|
||||
|
||||
* `Git for Windows <https://git-for-windows.github.io>`_ (command-line and GUI)
|
||||
* `tortoisegit <https://tortoisegit.org>`_ (GUI and File Explorer integration)
|
||||
|
||||
CMake
|
||||
^^^^^
|
||||
You can get the win32 installer version from
|
||||
`the official site <https://cmake.org/download/>`_.
|
||||
It has the usual installer wizard. Make sure you let it add its binary folder
|
||||
to your binary search PATH so the tool can be later run from anywhere.
|
||||
|
||||
Perl / Strawberry Perl
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
For the code generation stage of the build process, you'll need Perl 5 with
|
||||
XML::LibXML and XML::LibXSLT. `Strawberry Perl <http://strawberryperl.com>`_ is
|
||||
recommended as it includes all of the required packages in a single, easy
|
||||
install.
|
||||
|
||||
After install, ensure Perl is in your user's PATH. This can be edited from
|
||||
``Control Panel -> System -> Advanced System Settings -> Environment Variables``.
|
||||
|
||||
The following directories must be in your PATH, in this order:
|
||||
|
||||
* ``<path to perl>\c\bin``
|
||||
* ``<path to perl>\perl\site\bin``
|
||||
* ``<path to perl>\perl\bin``
|
||||
* ``<path to perl>\perl\vendor\lib\auto\XML\LibXML`` (may only be required on some systems)
|
||||
|
||||
Be sure to close and re-open any existing ``cmd.exe`` windows after updating
|
||||
your PATH.
|
||||
|
||||
If you already have a different version of Perl installed (for example, from Cygwin),
|
||||
you can run into some trouble. Either remove the other Perl install from PATH, or
|
||||
install XML::LibXML and XML::LibXSLT for it using CPAN.
|
||||
|
||||
Build
|
||||
-----
|
||||
There are several different batch files in the ``win32`` and ``win64``
|
||||
subfolders in the ``build`` folder, along with a script that's used for picking
|
||||
the DF path. Use the subfolder corresponding to the architecture that you want
|
||||
to build for.
|
||||
|
||||
First, run ``set_df_path.vbs`` and point the dialog that pops up at
|
||||
a suitable DF installation which is of the appropriate version for the DFHack
|
||||
you are compiling. The result is the creation of the file ``DF_PATH.txt`` in
|
||||
the build directory. It contains the full path to the destination directory.
|
||||
You could therefore also create this file manually - or copy in a pre-prepared
|
||||
version - if you prefer.
|
||||
|
||||
Next, run one of the scripts with ``generate`` prefix. These create the MSVC
|
||||
solution file(s):
|
||||
|
||||
* ``all`` will create a solution with everything enabled (and the kitchen sink).
|
||||
* ``gui`` will pop up the CMake GUI and let you choose what to build.
|
||||
This is probably what you want most of the time. Set the options you are interested
|
||||
in, then hit configure, then generate. More options can appear after the configure step.
|
||||
* ``minimal`` will create a minimal solution with just the bare necessities -
|
||||
the main library and standard plugins.
|
||||
* ``release`` will create a solution with everything that should be included in
|
||||
release builds of DFHack. Note that this includes documentation, which requires
|
||||
Python.
|
||||
|
||||
Then you can either open the solution with MSVC or use one of the msbuild scripts:
|
||||
|
||||
Building/installing from the command line:
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
In the build directory you will find several ``.bat`` files:
|
||||
|
||||
* Scripts with ``build`` prefix will only build DFHack.
|
||||
* Scripts with ``install`` prefix will build DFHack and install it to the previously selected DF path.
|
||||
* Scripts with ``package`` prefix will build and create a .zip package of DFHack.
|
||||
|
||||
Compiling from the command line is generally the quickest and easiest option.
|
||||
However be aware that due to the limitations of ``cmd.exe`` - especially in
|
||||
versions of Windows prior to Windows 10 - it can be very hard to see what happens
|
||||
during a build. If you get a failure, you may miss important errors or warnings
|
||||
due to the tiny window size and extremely limited scrollback. For that reason you
|
||||
may prefer to compile in the IDE which will always show all build output.
|
||||
|
||||
Alternatively (or additionally), consider installing an improved Windows terminal
|
||||
such as `Cmder <https://cmder.net/>`_. Easily installed through Chocolatey with:
|
||||
``choco install cmder -y``.
|
||||
|
||||
**Note for Cygwin/msysgit users**: It is also possible to compile DFHack from a
|
||||
Bash command line. This has three potential benefits:
|
||||
|
||||
* When you've installed Git and are using its Bash, but haven't added Git to your path:
|
||||
|
||||
* You can load Git's Bash and as long as it can access Perl and CMake, you can
|
||||
use it for compile without adding Git to your system path.
|
||||
|
||||
* When you've installed Cygwin and its SSH server:
|
||||
|
||||
* You can now SSH in to your Windows install and compile from a remote terminal;
|
||||
very useful if your Windows installation is a local VM on a \*nix host OS.
|
||||
|
||||
* In general: you can use Bash as your compilation terminal, meaning you have a decent
|
||||
sized window, scrollback, etc.
|
||||
|
||||
* Whether you're accessing it locally as with Git's Bash, or remotely through
|
||||
Cygwin's SSH server, this is far superior to using ``cmd.exe``.
|
||||
|
||||
You don't need to do anything special to compile from Bash. As long as your PATHs
|
||||
are set up correctly, you can run the same generate- and build/install/package- bat
|
||||
files as detailed above.
|
||||
|
||||
Building/installing from the Visual Studio IDE:
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
After running the CMake generate script you will have a new folder called VC2015
|
||||
or VC2015_32, depending on the architecture you specified. Open the file
|
||||
``dfhack.sln`` inside that folder. If you have multiple versions of Visual
|
||||
Studio installed, make sure you open with Visual Studio 2015.
|
||||
|
||||
The first thing you must then do is change the build type. It defaults to Debug,
|
||||
but this cannot be used on Windows. Debug is not binary-compatible with DF.
|
||||
If you try to use a debug build with DF, you'll only get crashes and for this
|
||||
reason the Windows "debug" scripts actually do RelWithDebInfo builds.
|
||||
After loading the Solution, change the Build Type to either ``Release``
|
||||
or ``RelWithDebInfo``.
|
||||
|
||||
Then build the ``INSTALL`` target listed under ``CMakePredefinedTargets``.
|
||||
|
||||
Windows cross compiling from Linux
|
||||
==================================
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
If you are on Linux but need to produce a Windows build (for example, because the
|
||||
DF version you're working on isn't out for Linux yet), here is how you can build
|
||||
and run a Windows binary on Linux.
|
||||
|
||||
Step 1: prepare a docker image
|
||||
------------------------------
|
||||
|
||||
On your Linux host, install and run the docker daemon and then run these commands::
|
||||
|
||||
xhost +local:root
|
||||
git clone https://github.com/BenLubar/build-env.git
|
||||
cd build-env/msvc
|
||||
docker build .
|
||||
docker image ls
|
||||
IMAGE_ID=<your image id>
|
||||
docker run -it --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" --volume=/tmp/.X11-unix:/tmp/.X11-unix --user buildmaster --name dfhack-win $IMAGE_ID
|
||||
|
||||
The ``xhost`` command and ``--env`` parameters are there so you can eventually
|
||||
run Dwarf Fortress from the container and have it display on your host.
|
||||
|
||||
Step 2: build DFHack
|
||||
--------------------
|
||||
|
||||
The ``docker run`` command above will give you a shell prompt (as root) in the
|
||||
container. Inside the container, run the following commands::
|
||||
|
||||
git clone https://github.com/DFHack/dfhack.git
|
||||
cd dfhack
|
||||
git submodule update --init
|
||||
cd build
|
||||
dfhack-configure windows 64 Release
|
||||
dfhack-make
|
||||
|
||||
Inside the ``dfhack-*`` scripts there are several commands that set up the wine
|
||||
server. Each invocation of a windows tool will cause wine to run in the container.
|
||||
Preloading the wineserver and telling it not to exit will speed configuration and
|
||||
compilation up considerably (approx. 10x). You can configure and build DFHack
|
||||
with regular ``cmake`` and ``ninja`` commands, but your build will go much slower.
|
||||
|
||||
Step 3: copy Dwarf Fortress to the container
|
||||
--------------------------------------------
|
||||
|
||||
First, create a directory in the container to house the Dwarf Fortress binary and
|
||||
assets::
|
||||
|
||||
mkdir ~/df
|
||||
|
||||
If you can just downlaod Dwarf Fortress directly into the container, then that's fine.
|
||||
Otherwise, you can do something like this in your host Linux environment to copy an
|
||||
installed version to the container::
|
||||
|
||||
cd ~/.steam/steam/steamapps/common/Dwarf\ Fortress/
|
||||
docker cp . dfhack-win:df/
|
||||
|
||||
Step 4: install DFHack and run DF
|
||||
---------------------------------
|
||||
|
||||
Back in the container, run the following commands::
|
||||
|
||||
cd dfhack/build
|
||||
cmake .. -DCMAKE_INSTALL_PREFIX=/home/buildmaster/df
|
||||
ninja install
|
||||
cd ~/df
|
||||
wine64 "Dwarf Fortress.exe"
|
||||
|
||||
Other notes
|
||||
-----------
|
||||
|
||||
Closing your shell will kick you out of the container. Run this command on your Linux
|
||||
host when you want to reattach::
|
||||
|
||||
docker start -ai dfhack-win
|
||||
|
||||
If you edit code and need to rebuild, run ``dfhack-make`` and then ``ninja install``.
|
||||
That will handle all the wineserver management for you.
|
||||
|
||||
Building the documentation
|
||||
==========================
|
||||
|
||||
The steps above will not build DFHack's documentation by default. If you are
|
||||
editing documentation, see `documentation` for details on how to build it.
|
||||
|
||||
Misc. Notes
|
||||
===========
|
||||
|
||||
.. _note-offline-builds:
|
||||
|
||||
Note on building DFHack offline
|
||||
-------------------------------
|
||||
|
||||
As of 0.43.05, DFHack downloads several files during the build process, depending
|
||||
on your target OS and architecture. If your build machine's internet connection
|
||||
is unreliable, or nonexistent, you can download these files in advance.
|
||||
|
||||
First, you must locate the files you will need. These can be found in the
|
||||
`dfhack-bin repo <https://github.com/DFHack/dfhack-bin/releases>`_. Look for the
|
||||
most recent version number *before or equal to* the DF version which you are
|
||||
building for. For example, suppose "0.43.05" and "0.43.07" are listed. You should
|
||||
choose "0.43.05" if you are building for 0.43.05 or 0.43.06, and "0.43.07" if
|
||||
you are building for 0.43.07 or 0.43.08.
|
||||
|
||||
Then, download all of the files you need, and save them to ``<path to DFHack
|
||||
clone>/CMake/downloads/<any filename>``. The destination filename you choose
|
||||
does not matter, as long as the files end up in the ``CMake/downloads`` folder.
|
||||
You need to download all of the files for the architecture(s) you are building
|
||||
for. For example, if you are building for 32-bit Linux and 64-bit Windows,
|
||||
download all files starting with ``linux32`` and ``win64``. GitHub should sort
|
||||
files alphabetically, so all the files you need should be next to each other.
|
||||
|
||||
.. note::
|
||||
|
||||
* Any files containing "allegro" in their filename are only necessary for
|
||||
building `stonesense`. If you are not building Stonesense, you don't have to
|
||||
download these, as they are larger than any other listed files.
|
||||
|
||||
It is recommended that you create a build folder and run CMake to verify that
|
||||
you have downloaded everything at this point, assuming your download machine has
|
||||
CMake installed. This involves running a "generate" batch script on Windows, or
|
||||
a command starting with ``cmake .. -G Ninja`` on Linux and macOS, following the
|
||||
instructions in the sections above. CMake should automatically locate files that
|
||||
you placed in ``CMake/downloads``, and use them instead of attempting to
|
||||
download them.
|
||||
@ -0,0 +1,406 @@
|
||||
.. highlight:: shell
|
||||
|
||||
.. _compile:
|
||||
|
||||
###########
|
||||
Compilation
|
||||
###########
|
||||
|
||||
DFHack builds are available for all supported platforms; see `installing` for
|
||||
installation instructions. If you are a DFHack end-user, modder, or plan on
|
||||
writing scripts [lua] (not plugins), it is generally recommended (and easier) to use
|
||||
these `builds <https://github.com/DFHack/dfhack/releases>`_ instead of compiling DFHack from source.
|
||||
|
||||
However, if you are looking to develop plugins, work on the DFHack core, make
|
||||
complex changes to DF-structures, or anything else that requires compiling
|
||||
DFHack from source, this document will walk you through the build process. Note
|
||||
that some steps may be unconventional compared to other projects, so be sure to
|
||||
pay close attention if this is your first time compiling DFHack.
|
||||
|
||||
.. contents:: Contents
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
.. _compile-how-to-get-the-code:
|
||||
|
||||
How to get the code
|
||||
===================
|
||||
DFHack uses Git for source control; instructions for installing Git can be found
|
||||
in the platform-specific sections below. The code is hosted on
|
||||
`GitHub <https://github.com/DFHack/dfhack>`_, and can be downloaded with::
|
||||
|
||||
git clone --recursive https://github.com/DFHack/dfhack
|
||||
cd dfhack
|
||||
|
||||
If your version of Git does not support the ``--recursive`` flag, you will need
|
||||
to omit it and run ``git submodule update --init`` after entering the dfhack
|
||||
directory.
|
||||
|
||||
This will check out the code on the default branch of the GitHub repo, currently
|
||||
``develop``, which may be unstable. If you want code for the latest stable
|
||||
release, you can check out the ``master`` branch instead::
|
||||
|
||||
git checkout master
|
||||
git submodule update
|
||||
|
||||
In general, a single DFHack clone is suitable for development - most Git
|
||||
operations such as switching branches can be done on an existing clone. If you
|
||||
find yourself cloning DFHack frequently as part of your development process, or
|
||||
getting stuck on anything else Git-related, feel free to reach out to us for
|
||||
assistance.
|
||||
|
||||
.. admonition:: Offline builds
|
||||
|
||||
If you plan to build DFHack on a machine without an internet connection (or
|
||||
with an unreliable connection), see `note-offline-builds` for additional
|
||||
instructions.
|
||||
|
||||
.. admonition:: Working with submodules
|
||||
|
||||
DFHack uses submodules extensively to manage its subprojects (including the
|
||||
``scripts`` folder and DF-structures in ``library/xml``). Failing to keep
|
||||
submodules in sync when switching between branches can result in build errors
|
||||
or scripts that don't work. In general, you should always update submodules
|
||||
whenever you switch between branches in the main DFHack repo with
|
||||
``git submodule update``. (If you are working on bleeding-edge DFHack and
|
||||
have checked out the master branch of some submodules, running ``git pull``
|
||||
in those submodules is also an option.)
|
||||
|
||||
Rarely, we add or remove submodules. If there are any changes to the existence
|
||||
of submodules when you switch between branches, you should run
|
||||
``git submodule update --init`` instead (adding ``--init`` to the above
|
||||
command).
|
||||
|
||||
Some common errors that can arise when failing to update submodules include:
|
||||
|
||||
* ``fatal: <some path> does not exist`` when performing Git operations
|
||||
* Build errors, particularly referring to structures in the ``df::`` namespace
|
||||
or the ``library/include/df`` folder
|
||||
* ``Not a known DF version`` when starting DF
|
||||
* ``Run 'git submodule update --init'`` when running CMake
|
||||
|
||||
Submodules are a particularly confusing feature of Git. The
|
||||
`Git Book <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_ has a
|
||||
thorough explanation of them (as well as of many other aspects of Git) and
|
||||
is a recommended resource if you run into any issues. Other DFHack developers
|
||||
are also able to help with any submodule-related (or Git-related) issues
|
||||
you may encounter.
|
||||
|
||||
All Platforms
|
||||
=============
|
||||
Before you can compile the code you'll need to configure your build with cmake. Some IDEs can do this,
|
||||
but from command line is the usual way to do this; thought the Windows section below points out some
|
||||
Windows batch files that can be used to avoid opening a terminal/command-prompt.
|
||||
|
||||
You should seek cmake's documentation online or via ``cmake --help`` to see how the command works. See
|
||||
the `build-options` page for help finding the DFHack build options relevant to you.
|
||||
|
||||
Before compiling code, you'll of course need code to compile. This **will include** the submodules, so
|
||||
be sure you've read the section about getting the code.
|
||||
|
||||
.. _compile-linux:
|
||||
|
||||
Linux
|
||||
=====
|
||||
On Linux, DFHack acts as a library that shadows parts of the SDL API using LD_PRELOAD.
|
||||
|
||||
Build
|
||||
-----
|
||||
Building is fairly straightforward. Enter the ``build`` folder (or create an
|
||||
empty folder in the DFHack directory to use instead) and start the build like this::
|
||||
|
||||
cd build
|
||||
cmake .. -G Ninja -DCMAKE_BUILD_TYPE:string=Release -DCMAKE_INSTALL_PREFIX=<path to DF>
|
||||
ninja install # or ninja -jX install to specify the number of cores (X) to use
|
||||
|
||||
<path to DF> should be a path to a copy of Dwarf Fortress, of the appropriate
|
||||
version for the DFHack you are building. This will build the library along
|
||||
with the normal set of plugins and install them into your DF folder.
|
||||
|
||||
Alternatively, you can use ccmake instead of cmake::
|
||||
|
||||
cd build
|
||||
ccmake .. -G Ninja
|
||||
ninja install
|
||||
|
||||
This will show a curses-based interface that lets you set all of the
|
||||
extra options. You can also use a cmake-friendly IDE like KDevelop 4
|
||||
or the cmake-gui program.
|
||||
|
||||
.. _compile-windows:
|
||||
|
||||
Windows
|
||||
=======
|
||||
There are several different batch files in the ``win32`` and ``win64``
|
||||
subfolders in the ``build`` folder, along with a script that's used for picking
|
||||
the DF path. Use the subfolder corresponding to the architecture that you want
|
||||
to build for.
|
||||
|
||||
First, run ``set_df_path.vbs`` and point the dialog that pops up at
|
||||
a suitable DF installation which is of the appropriate version for the DFHack
|
||||
you are compiling. The result is the creation of the file ``DF_PATH.txt`` in
|
||||
the build directory. It contains the full path to the destination directory.
|
||||
You could therefore also create this file manually - or copy in a pre-prepared
|
||||
version - if you prefer.
|
||||
|
||||
Next, run one of the scripts with ``generate`` prefix. These create the MSVC
|
||||
solution file(s):
|
||||
|
||||
* ``all`` will create a solution with everything enabled (and the kitchen sink).
|
||||
* ``gui`` will pop up the CMake GUI and let you choose what to build.
|
||||
This is probably what you want most of the time. Set the options you are interested
|
||||
in, then hit configure, then generate. More options can appear after the configure step.
|
||||
* ``minimal`` will create a minimal solution with just the bare necessities -
|
||||
the main library and standard plugins.
|
||||
* ``release`` will create a solution with everything that should be included in
|
||||
release builds of DFHack. Note that this includes documentation, which requires
|
||||
Python.
|
||||
|
||||
Then you can either open the solution with MSVC or use one of the msbuild scripts.
|
||||
|
||||
Visual Studio IDE
|
||||
-----------------
|
||||
After running the CMake generate script you will have a new folder called VC2022
|
||||
or VC2022_32, depending on the architecture you specified. Open the file
|
||||
``dfhack.sln`` inside that folder. If you have multiple versions of Visual
|
||||
Studio installed, make sure you open with Visual Studio 2022.
|
||||
|
||||
The first thing you must then do is change the build type. It defaults to Debug,
|
||||
but this cannot be used on Windows. Debug is not binary-compatible with DF.
|
||||
If you try to use a debug build with DF, you'll only get crashes and for this
|
||||
reason the Windows "debug" scripts actually do RelWithDebInfo builds.
|
||||
After loading the Solution, change the Build Type to either ``Release``
|
||||
or ``RelWithDebInfo``.
|
||||
|
||||
Then build the ``INSTALL`` target listed under ``CMakePredefinedTargets``.
|
||||
|
||||
Command Line
|
||||
------------
|
||||
In the build directory you will find several ``.bat`` files:
|
||||
|
||||
* Scripts with ``build`` prefix will only build DFHack.
|
||||
* Scripts with ``install`` prefix will build DFHack and install it to the previously selected DF path.
|
||||
* Scripts with ``package`` prefix will build and create a .zip package of DFHack.
|
||||
|
||||
Compiling from the command line is generally the quickest and easiest option.
|
||||
Modern Windows terminal emulators such as `Cmder <https://cmder.app/>`_ or
|
||||
`Windows Terminal <https://github.com/microsoft/terminal>`_ provide a better
|
||||
experience by providing more scrollback and larger window sizes.
|
||||
|
||||
.. _compile-macos:
|
||||
|
||||
macOS
|
||||
=====
|
||||
DFHack functions similarly on macOS and Linux, and the majority of the
|
||||
information above regarding the build process (CMake and Ninja) applies here
|
||||
as well.
|
||||
|
||||
DFHack can officially be built on macOS only with GCC 4.8 or 7. Anything newer than 7
|
||||
will require you to perform extra steps to get DFHack to run (see `osx-new-gcc-notes`),
|
||||
and your build will likely not be redistributable.
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
* Get the DFHack source as per section `compile-how-to-get-the-code`, above.
|
||||
* Set environment variables
|
||||
|
||||
Homebrew (if installed elsewhere, replace /usr/local with ``$(brew --prefix)``)::
|
||||
|
||||
export CC=/usr/local/bin/gcc-7
|
||||
export CXX=/usr/local/bin/g++-7
|
||||
|
||||
Macports::
|
||||
|
||||
export CC=/opt/local/bin/gcc-mp-7
|
||||
export CXX=/opt/local/bin/g++-mp-7
|
||||
|
||||
Change the version numbers appropriately if you installed a different version of GCC.
|
||||
|
||||
If you are confident that you have GCC in your path, you can omit the absolute paths::
|
||||
|
||||
export CC=gcc-7
|
||||
export CXX=g++-7
|
||||
|
||||
(adjust as needed for different GCC installations)
|
||||
|
||||
* Build DFHack::
|
||||
|
||||
mkdir build-osx
|
||||
cd build-osx
|
||||
cmake .. -G Ninja -DCMAKE_BUILD_TYPE:string=Release -DCMAKE_INSTALL_PREFIX=<path to DF>
|
||||
ninja install # or ninja -jX install to specify the number of cores (X) to use
|
||||
|
||||
<path to DF> should be a path to a copy of Dwarf Fortress, of the appropriate
|
||||
version for the DFHack you are building.
|
||||
|
||||
.. _osx-new-gcc-notes:
|
||||
|
||||
Notes for GCC 8+ or OS X 10.10+ users
|
||||
-------------------------------------
|
||||
|
||||
If you have issues building on OS X 10.10 (Yosemite) or above, try defining
|
||||
the following environment variable::
|
||||
|
||||
export MACOSX_DEPLOYMENT_TARGET=10.9
|
||||
|
||||
If you build with a GCC version newer than 7, DFHack will probably crash
|
||||
immediately on startup, or soon after. To fix this, you will need to replace
|
||||
``hack/libstdc++.6.dylib`` with a symlink to the ``libstdc++.6.dylib`` included
|
||||
in your version of GCC::
|
||||
|
||||
cd <path to df>/hack && mv libstdc++.6.dylib libstdc++.6.dylib.orig &&
|
||||
ln -s [PATH_TO_LIBSTDC++] .
|
||||
|
||||
For example, with GCC 6.3.0, ``PATH_TO_LIBSTDC++`` would be::
|
||||
|
||||
/usr/local/Cellar/gcc@6/6.3.0/lib/gcc/6/libstdc++.6.dylib # for 64-bit DFHack
|
||||
/usr/local/Cellar/gcc@6/6.3.0/lib/gcc/6/i386/libstdc++.6.dylib # for 32-bit DFHack
|
||||
|
||||
**Note:** If you build with a version of GCC that requires this, your DFHack
|
||||
build will *not* be redistributable. (Even if you copy the ``libstdc++.6.dylib``
|
||||
from your GCC version and distribute that too, it will fail on older OS X
|
||||
versions.) For this reason, if you plan on distributing DFHack, it is highly
|
||||
recommended to use GCC 4.8 or 7.
|
||||
|
||||
.. _osx-m1-notes:
|
||||
|
||||
Notes for M1 users
|
||||
------------------
|
||||
|
||||
Alongside the above, you will need to follow these additional steps to get it
|
||||
running on Apple silicon.
|
||||
|
||||
Install an x86 copy of ``homebrew`` alongside your existing one. `This
|
||||
stackoverflow answer <https://stackoverflow.com/a/64951025>`__ describes the
|
||||
process.
|
||||
|
||||
Follow the normal macOS steps to install ``cmake`` and ``gcc`` via your x86 copy of
|
||||
``homebrew``. Note that this will install a GCC version newer than 7, so see
|
||||
`osx-new-gcc-notes`.
|
||||
|
||||
In your terminal, ensure you have your path set to the correct homebrew in
|
||||
addition to the normal ``CC`` and ``CXX`` flags above::
|
||||
|
||||
export PATH=/usr/local/bin:$PATH
|
||||
|
||||
Windows cross compiling from Linux
|
||||
==================================
|
||||
|
||||
.. highlight:: bash
|
||||
|
||||
You can use docker to build DFHack for Windows. These instructions were developed
|
||||
on a Linux host system.
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
Step 1: prepare a docker image
|
||||
------------------------------
|
||||
|
||||
On your Linux host, install and run the docker daemon and then run these commands::
|
||||
|
||||
xhost +local:root
|
||||
git clone https://github.com/BenLubar/build-env.git
|
||||
cd build-env/msvc
|
||||
docker build .
|
||||
docker image ls
|
||||
IMAGE_ID=<your image id>
|
||||
docker run -it --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" --volume=/tmp/.X11-unix:/tmp/.X11-unix --user buildmaster --name dfhack-win $IMAGE_ID
|
||||
|
||||
The ``xhost`` command and ``--env`` parameters are there so you can eventually
|
||||
run Dwarf Fortress from the container and have it display on your host.
|
||||
|
||||
Step 2: build DFHack
|
||||
--------------------
|
||||
|
||||
The ``docker run`` command above will give you a shell prompt (as the ``buildmaster`` user) in the
|
||||
container. Inside the container, run the following commands::
|
||||
|
||||
git clone https://github.com/DFHack/dfhack.git
|
||||
cd dfhack
|
||||
git submodule update --init
|
||||
cd build
|
||||
dfhack-configure windows 64 Release
|
||||
dfhack-make
|
||||
|
||||
Inside the ``dfhack-*`` scripts there are several commands that set up the wine
|
||||
server. Each invocation of a Windows tool will cause wine to run in the container.
|
||||
Preloading the wineserver and telling it not to exit will speed configuration and
|
||||
compilation up considerably (approx. 10x). You can configure and build DFHack
|
||||
with regular ``cmake`` and ``ninja`` commands, but your build will go much slower.
|
||||
|
||||
Step 3: copy Dwarf Fortress to the container
|
||||
--------------------------------------------
|
||||
|
||||
First, create a directory in the container to house the Dwarf Fortress binary and
|
||||
assets::
|
||||
|
||||
mkdir ~/df
|
||||
|
||||
If you can just download Dwarf Fortress directly into the container, then that's fine.
|
||||
Otherwise, you can do something like this in your host Linux environment to copy an
|
||||
installed version to the container::
|
||||
|
||||
cd ~/.steam/steam/steamapps/common/Dwarf\ Fortress/
|
||||
docker cp . dfhack-win:df/
|
||||
|
||||
Step 4: install DFHack and run DF
|
||||
---------------------------------
|
||||
|
||||
Back in the container, run the following commands::
|
||||
|
||||
cd dfhack/build
|
||||
cmake .. -DCMAKE_INSTALL_PREFIX=/home/buildmaster/df
|
||||
ninja install
|
||||
cd ~/df
|
||||
wine64 "Dwarf Fortress.exe"
|
||||
|
||||
Other notes
|
||||
-----------
|
||||
|
||||
Closing your shell will kick you out of the container. Run this command on your Linux
|
||||
host when you want to reattach::
|
||||
|
||||
docker start -ai dfhack-win
|
||||
|
||||
If you edit code and need to rebuild, run ``dfhack-make`` and then ``ninja install``.
|
||||
That will handle all the wineserver management for you.
|
||||
|
||||
.. _note-offline-builds:
|
||||
|
||||
Building DFHack Offline
|
||||
=======================
|
||||
As of 0.43.05, DFHack downloads several files during the build process, depending
|
||||
on your target OS and architecture. If your build machine's internet connection
|
||||
is unreliable, or nonexistent, you can download these files in advance.
|
||||
|
||||
First, you must locate the files you will need. These can be found in the
|
||||
`dfhack-bin repo <https://github.com/DFHack/dfhack-bin/releases>`_. Look for the
|
||||
most recent version number *before or equal to* the DF version which you are
|
||||
building for. For example, suppose "0.43.05" and "0.43.07" are listed. You should
|
||||
choose "0.43.05" if you are building for 0.43.05 or 0.43.06, and "0.43.07" if
|
||||
you are building for 0.43.07 or 0.43.08.
|
||||
|
||||
Then, download all of the files you need, and save them to ``<path to DFHack
|
||||
clone>/CMake/downloads/<any filename>``. The destination filename you choose
|
||||
does not matter, as long as the files end up in the ``CMake/downloads`` folder.
|
||||
You need to download all of the files for the architecture(s) you are building
|
||||
for. For example, if you are building for 32-bit Linux and 64-bit Windows,
|
||||
download all files starting with ``linux32`` and ``win64``. GitHub should sort
|
||||
files alphabetically, so all the files you need should be next to each other.
|
||||
|
||||
.. note::
|
||||
|
||||
* Any files containing "allegro" in their filename are only necessary for
|
||||
building `stonesense`. If you are not building Stonesense, you don't have to
|
||||
download these, as they are larger than any other listed files.
|
||||
|
||||
It is recommended that you create a build folder and run CMake to verify that
|
||||
you have downloaded everything at this point, assuming your download machine has
|
||||
CMake installed. This involves running a "generate" batch script on Windows, or
|
||||
a command starting with ``cmake .. -G Ninja`` on Linux and macOS, following the
|
||||
instructions in the sections above. CMake should automatically locate files that
|
||||
you placed in ``CMake/downloads``, and use them instead of attempting to
|
||||
download them.
|
||||
@ -0,0 +1,337 @@
|
||||
.. _build-dependencies:
|
||||
|
||||
############
|
||||
Dependencies
|
||||
############
|
||||
|
||||
The most immediate consideration is of course that DFHack is meant to be installed into an **existing DF folder**.
|
||||
So it is prudent that one is ready.
|
||||
|
||||
.. contents:: Contents
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
Build Dependencies
|
||||
------------------
|
||||
|
||||
..
|
||||
DFHack is quite large, so I've attempted to
|
||||
leave some sort of bread crumbs for each
|
||||
mentionable aspect.
|
||||
|
||||
Many of DFHack's build dependencies are included in the repository as git submodules,
|
||||
however there are some system dependencies as well. They are as follows:
|
||||
|
||||
System packages:
|
||||
|
||||
* SDL (libsdl 1.2, not sdl2).
|
||||
* cmake
|
||||
* Perl
|
||||
* Python
|
||||
|
||||
* Sphinx
|
||||
* git (required for `contributions <https://github.com/DFHack/dfhack/pulls>`_)
|
||||
* ccache (**optional**, but recommended to improve build times)
|
||||
* OpenGL headers (**optional**: to build `stonesense`)
|
||||
* zlib (compression library used for `xlsxreader-api` -> `quickfort`)
|
||||
* build system (e.g. gcc & ninja, or Visual Studio)
|
||||
|
||||
..
|
||||
maybe the below should be talked about next to the bullet point??
|
||||
|
||||
**SDL** is used as an injection point which you can see more about in DFHack's `architectural <architectural-diagrams>` documentation & diagrams.
|
||||
|
||||
Perl packages:
|
||||
|
||||
* XML::LibXML
|
||||
* XML::LibXSLT
|
||||
|
||||
These perl packages are used in code generation. DFHack has many structures that are reverse engineered, we use xml
|
||||
files to define and update these structures. Then during the configuration process [running cmake] these xml files are
|
||||
used to generate C++ source code to define these structures for use in plugins and scripts.
|
||||
|
||||
|
||||
Installing
|
||||
----------
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
.. _linux-dependency-instructions:
|
||||
|
||||
Linux
|
||||
=====
|
||||
|
||||
Here are some package install commands for various distributions:
|
||||
|
||||
* On Arch linux::
|
||||
|
||||
pacman -Sy gcc cmake ccmake ninja git dwarffortress zlib perl-xml-libxml perl-xml-libxslt
|
||||
|
||||
* The ``dwarffortress`` package provides the necessary SDL packages.
|
||||
* For the required Perl modules: ``perl-xml-libxml`` and ``perl-xml-libxslt`` (or through ``cpan``)
|
||||
|
||||
* On Ubuntu::
|
||||
|
||||
apt-get install gcc cmake ninja-build git zlib1g-dev libsdl1.2-dev libxml-libxml-perl libxml-libxslt-perl
|
||||
|
||||
* Other Debian-based distributions should have similar requirements.
|
||||
|
||||
* On Fedora::
|
||||
|
||||
yum install gcc-c++ cmake ninja-build git zlib-devel SDL-devel perl-core perl-XML-LibXML perl-XML-LibXSLT ruby
|
||||
|
||||
To build DFHack, you need GCC 4.8 or newer. GCC 4.8 has the benefit of avoiding
|
||||
`libstdc++ compatibility issues <linux-incompatible-libstdcxx>`, but can be hard
|
||||
to obtain on modern distributions, and working around these issues is done
|
||||
automatically by the ``dfhack`` launcher script. As long as your system-provided
|
||||
GCC is new enough, it should work. Note that extremely new GCC versions may not
|
||||
have been used to build DFHack yet, so if you run into issues with these, please
|
||||
let us know (e.g. by opening a GitHub issue).
|
||||
|
||||
Before you can build anything, you'll also need ``cmake``. It is advisable to
|
||||
also get ``ccmake`` on distributions that split the cmake package into multiple
|
||||
parts. As mentioned above, ``ninja`` is recommended (many distributions call
|
||||
this package ``ninja-build``).
|
||||
|
||||
You will need pthread; most systems should have this already. Note that older
|
||||
CMake versions may have trouble detecting pthread, so if you run into
|
||||
pthread-related errors and pthread is installed, you may need to upgrade CMake,
|
||||
either by downloading it from `cmake.org <https://cmake.org/download/>`_ or
|
||||
through your package manager, if possible.
|
||||
|
||||
Building 32-bit Binaries
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
If you want to compile 32-bit DFHack on 64-bit distributions, you'll need the
|
||||
multilib development tools and libraries:
|
||||
|
||||
* ``gcc-multilib`` and ``g++-multilib``
|
||||
* If you have installed a non-default version of GCC - for example, GCC 4.8 on a
|
||||
distribution that defaults to 5.x - you may need to add the version number to
|
||||
the multilib packages.
|
||||
|
||||
* For example, ``gcc-4.8-multilib`` and ``g++-4.8-multilib`` if installing for GCC 4.8
|
||||
on a system that uses a later GCC version.
|
||||
* This is definitely required on Ubuntu/Debian, check if using a different distribution.
|
||||
|
||||
* ``zlib1g-dev:i386`` (or a similar i386 zlib-dev package)
|
||||
|
||||
Note that installing a 32-bit GCC on 64-bit systems (e.g. ``gcc:i386`` on
|
||||
Debian) will typically *not* work, as it depends on several other 32-bit
|
||||
libraries that conflict with system libraries. Alternatively, you might be able
|
||||
to use ``lxc`` to
|
||||
:forums:`create a virtual 32-bit environment <139553.msg5435310#msg5435310>`.
|
||||
|
||||
.. _linux-incompatible-libstdcxx:
|
||||
|
||||
Incompatible libstdc++
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
When compiling DFHack yourself, it builds against your system libstdc++. When
|
||||
Dwarf Fortress runs, it uses a libstdc++ shipped in the ``libs`` folder, which
|
||||
comes from GCC 4.8 and is incompatible with code compiled with newer GCC
|
||||
versions. As of DFHack 0.42.05-alpha1, the ``dfhack`` launcher script attempts
|
||||
to fix this by automatically removing the DF-provided libstdc++ on startup.
|
||||
In rare cases, this may fail and cause errors such as:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
./libs/Dwarf_Fortress: /pathToDF/libs/libstdc++.so.6: version
|
||||
`GLIBCXX_3.4.18' not found (required by ./hack/libdfhack.so)
|
||||
|
||||
The easiest way to fix this is generally removing the libstdc++ shipped with
|
||||
DF, which causes DF to use your system libstdc++ instead::
|
||||
|
||||
cd /path/to/DF/
|
||||
rm libs/libstdc++.so.6
|
||||
|
||||
Note that distributing binaries compiled with newer GCC versions may result in
|
||||
the opposite compatibility issue: users with *older* GCC versions may encounter
|
||||
similar errors. This is why DFHack distributes both GCC 4.8 and GCC 7 builds. If
|
||||
you are planning on distributing binaries to other users, we recommend using an
|
||||
older GCC (but still at least 4.8) version if possible.
|
||||
|
||||
.. _windows-dependency-instructions:
|
||||
|
||||
Windows
|
||||
=======
|
||||
|
||||
DFHack must be built with the Microsoft Visual C++ 2022 toolchain (aka MSVC v143)
|
||||
for ABI compatibility with Dwarf Fortress v50.
|
||||
|
||||
With Choco
|
||||
~~~~~~~~~~
|
||||
Many of the dependencies are simple enough to download and install via the
|
||||
`chocolatey`_ package manager on the command line.
|
||||
|
||||
Here are some package install commands::
|
||||
|
||||
choco install cmake
|
||||
choco install ccache
|
||||
choco install strawberryperl
|
||||
choco install python
|
||||
choco install sphinx
|
||||
|
||||
# Visual Studio
|
||||
choco install visualstudio2022community --params "--add Microsoft.VisualStudio.Workload.NativeDesktop --includeRecommended"
|
||||
# OR
|
||||
# Build Tools for Visual Studio
|
||||
choco install visualstudio2022buildtools --params "--add Microsoft.VisualStudio.Workload.NativeDesktop --includeRecommended"
|
||||
|
||||
If you already have Visual Studio 2022 or the Build Tools installed, you may
|
||||
need to modify the installed version to include the workload components
|
||||
listed in the manual installation section, as chocolatey will not amend
|
||||
the existing install.
|
||||
|
||||
.. _chocolatey: https://chocolatey.org/install
|
||||
|
||||
Manually
|
||||
~~~~~~~~
|
||||
If you prefer to install manually rather than using Chocolatey, details and
|
||||
requirements are as below. If you do install manually, please ensure you
|
||||
have all **executables searchable in your PATH variable**.
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
CMake
|
||||
^^^^^
|
||||
You can get the win32 installer version from
|
||||
`the official site <https://cmake.org/download/>`_.
|
||||
It has the usual installer wizard. Make sure you let it add its binary folder
|
||||
to your binary search PATH so the tool can be later run from anywhere.
|
||||
|
||||
Perl / Strawberry Perl
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
For the code generation stage of the build process, you'll need Perl 5 with
|
||||
**XML::LibXML** and **XML::LibXSLT**. `Strawberry Perl <http://strawberryperl.com>`_ is
|
||||
recommended as it includes all of the required packages in a single easy
|
||||
install.
|
||||
|
||||
After install, ensure Perl is in your user's PATH. This can be edited from
|
||||
``Control Panel -> System -> Advanced System Settings -> Environment Variables``.
|
||||
|
||||
The following directories must be in your PATH, in this order:
|
||||
|
||||
* ``<path to perl>\c\bin``
|
||||
* ``<path to perl>\perl\site\bin``
|
||||
* ``<path to perl>\perl\bin``
|
||||
* ``<path to perl>\perl\vendor\lib\auto\XML\LibXML`` (path may only be required on some systems)
|
||||
|
||||
Be sure to close and re-open any existing ``cmd.exe`` windows after updating
|
||||
your PATH.
|
||||
|
||||
If you already have a different version of Perl installed (for example, from Cygwin),
|
||||
you can run into some trouble. Either remove the other Perl install from PATH, or
|
||||
install XML::LibXML and XML::LibXSLT for it using CPAN.
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
See the `Python`_ website.
|
||||
|
||||
.. _Python: https://www.python.org/downloads/
|
||||
|
||||
Sphinx
|
||||
^^^^^^
|
||||
See the `Sphinx`_ website.
|
||||
|
||||
.. _Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html
|
||||
|
||||
.. _install-visual-studio:
|
||||
|
||||
Visual Studio
|
||||
^^^^^^^^^^^^^
|
||||
The required toolchain can be installed as a part of either the `Visual Studio 2022 IDE`_
|
||||
or the `Build Tools for Visual Studio 2022`_. If you already have a preferred code
|
||||
editor, the Build Tools will be a smaller install. You may need to log into (or create)
|
||||
a Microsoft account in order to download Visual Studio.
|
||||
|
||||
.. _Visual Studio 2022 IDE: https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false
|
||||
.. _Build Tools for Visual Studio 2022: https://my.visualstudio.com/Downloads?q=Build%20Tools%20for%20Visual%20Studio%202022
|
||||
|
||||
|
||||
Build Tools [Without Visual Studio]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Click `Build Tools for Visual Studio 2022`_ and you will be prompted to login to your Microsoft account.
|
||||
Then you should be redirected to a page with various download options with 2022
|
||||
in their name. If this redirect doesn't occur, just copy, paste, and enter the
|
||||
download link again and you should see the options.
|
||||
|
||||
You want to select the most up-to-date version -- as of writing this is
|
||||
"Build Tools for Visual Studio 2022 (version 17.4)". "LTSC" is an extended
|
||||
support variant and is not required for our purposes.
|
||||
|
||||
When installing, select the "Desktop Development with C++" workload and ensure that the following are checked:
|
||||
|
||||
- MSVC v143 - VS 2022 C++ x64/x86 build tools
|
||||
- C++ CMake tools for Windows
|
||||
- At least one Windows SDK (for example, Windows 11 SDK 10.0.22621).
|
||||
|
||||
.. _mac-dependency-instructions:
|
||||
|
||||
macOS
|
||||
=====
|
||||
|
||||
DFHack can officially be built on macOS only with GCC 4.8 or 7. Anything newer than 7
|
||||
will require you to perform extra steps to get DFHack to run (see `osx-new-gcc-notes`),
|
||||
and your build will likely not be redistributable.
|
||||
|
||||
#. Download and unpack a copy of the latest DF
|
||||
#. Install Xcode from the Mac App Store
|
||||
|
||||
#. Install the XCode Command Line Tools by running the following command::
|
||||
|
||||
xcode-select --install
|
||||
|
||||
#. Install dependencies
|
||||
|
||||
It is recommended to use Homebrew instead of MacPorts, as it is generally
|
||||
cleaner, quicker, and smarter. For example, installing MacPort's GCC will
|
||||
install more than twice as many dependencies as Homebrew's will, and all in
|
||||
both 32-bit and 64-bit variants. Homebrew also doesn't require constant use
|
||||
of ``sudo``.
|
||||
|
||||
Using `Homebrew <https://brew.sh/>`_ (recommended)::
|
||||
|
||||
brew tap homebrew/versions
|
||||
brew install git
|
||||
brew install cmake
|
||||
brew install ninja
|
||||
brew install gcc@7
|
||||
|
||||
Using `MacPorts <https://www.macports.org>`_::
|
||||
|
||||
sudo port install gcc7 +universal cmake +universal git-core +universal ninja +universal
|
||||
|
||||
Macports will take some time - maybe hours. At some point it may ask
|
||||
you to install a Java environment; let it do so.
|
||||
|
||||
#. Install Perl dependencies
|
||||
|
||||
* Using system Perl
|
||||
|
||||
* ``sudo cpan``
|
||||
|
||||
If this is the first time you've run cpan, you will need to go through the setup
|
||||
process. Just stick with the defaults for everything and you'll be fine.
|
||||
|
||||
If you are running OS X 10.6 (Snow Leopard) or earlier, good luck!
|
||||
You'll need to open a separate Terminal window and run::
|
||||
|
||||
sudo ln -s /usr/include/libxml2/libxml /usr/include/libxml
|
||||
|
||||
* ``install XML::LibXML``
|
||||
* ``install XML::LibXSLT``
|
||||
|
||||
* In a separate, local Perl install
|
||||
|
||||
Rather than using system Perl, you might also want to consider
|
||||
the Perl manager, `Perlbrew <https://perlbrew.pl>`_.
|
||||
|
||||
This manages Perl 5 locally under ``~/perl5/``, providing an easy
|
||||
way to install Perl and run CPAN against it without ``sudo``.
|
||||
It can maintain multiple Perl installs and being local has the
|
||||
benefit of easy migration and insulation from OS issues and upgrades.
|
||||
|
||||
See https://perlbrew.pl/ for more details.
|
||||
@ -0,0 +1,153 @@
|
||||
.. _build-options:
|
||||
|
||||
#############
|
||||
Build Options
|
||||
#############
|
||||
|
||||
.. contents:: Typical Options
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
There are a variety of other settings which you can find in CMakeCache.txt in
|
||||
your build folder or by running ``ccmake`` (or another CMake GUI). Most
|
||||
DFHack-specific settings begin with ``BUILD_`` and control which parts of DFHack
|
||||
are built.
|
||||
|
||||
Typical usage may look like::
|
||||
|
||||
# Plugin development with updated documentation
|
||||
cmake ./ -G Ninja -B builds/debug-info/ -DCMAKE_INSTALL_PREFIX=<path to DF> -DCMAKE_BUILD_TYPE:string=RelWithDebInfo -DBUILD_DOCS:bool=ON -DBUILD_PLUGINS=1
|
||||
# Core DFHack only
|
||||
cmake ../ -G Ninja -DCMAKE_INSTALL_PREFIX=<path to DF> -DCMAKE_BUILD_TYPE:string=RelWithDebInfo -DBUILD_TESTS -DBUILD_DOCS:0 -DBUILD_PLUGINS=0
|
||||
|
||||
.. admonition:: Modifying Build Options
|
||||
|
||||
You can typically run new cmake commands from your build directory to turn on/off options.
|
||||
Of course the generator selection is not something you can change, but the rest are.
|
||||
|
||||
Additionally, you can edit the build settings in CMakeCache.txt. You also have cmake's
|
||||
configuration utility ``ccmake``.
|
||||
|
||||
Generator
|
||||
=========
|
||||
For the uninitiated, the generator is what allows cmake to, of course, generate
|
||||
visual studio solution & project files, a makefile, or anything else.
|
||||
Your selection of generator comes down to preference and availability.
|
||||
|
||||
Visual Studio
|
||||
-------------
|
||||
To generate visual studio project files, you'll need to select a particular version of
|
||||
visual studio, and match that to your system's generator list viewed with ``cmake --help``
|
||||
|
||||
example::
|
||||
|
||||
cmake .. -G "Visual Studio 17 2022"
|
||||
|
||||
Ninja
|
||||
-----
|
||||
The generally preferred build system where available.
|
||||
|
||||
example::
|
||||
|
||||
cmake .. -G Ninja
|
||||
|
||||
Install Location
|
||||
================
|
||||
This is the location where DFHack will be installed.
|
||||
|
||||
Variable: ``CMAKE_INSTALL_PREFIX``
|
||||
|
||||
Usage::
|
||||
|
||||
cmake .. -DCMAKE_INSTALL_PREFIX=<path to df>
|
||||
|
||||
The path to df will of course depend on your system. If the directory exists it is
|
||||
recommended to use ``~/.dwarffortress`` to avoid permission troubles.
|
||||
|
||||
Build type
|
||||
==========
|
||||
This is the type of build you want. This controls what information about symbols and
|
||||
line numbers the debugger will have available to it.
|
||||
|
||||
Variable: ``CMAKE_BUILD_TYPE``
|
||||
|
||||
Usage::
|
||||
|
||||
cmake .. -DCMAKE_BUILD_TYPE:string=RelWithDebInfo
|
||||
|
||||
Options:
|
||||
|
||||
* Release
|
||||
* RelWithDebInfo
|
||||
|
||||
Target architecture (32/64-bit)
|
||||
===============================
|
||||
You can set this if you need 32-bit binaries or are looking to be explicit about
|
||||
building 64-bit.
|
||||
|
||||
Variable: ``DFHACK_BUILD_ARCH``
|
||||
|
||||
Usage::
|
||||
|
||||
cmake .. -DDFHACK_BUILD_ARCH=32
|
||||
|
||||
Options:
|
||||
|
||||
* '32'
|
||||
* '64' (default option)
|
||||
|
||||
Library
|
||||
=======
|
||||
This will only be useful if you're looking to avoid building the library core, as it builds by default.
|
||||
|
||||
Variable: ``BUILD_LIBRARY``
|
||||
|
||||
Usage::
|
||||
|
||||
cmake .. -DBUILD_LIBRARY:bool=OFF
|
||||
cmake .. -DBUILD_LIBRARY=0
|
||||
|
||||
Testing
|
||||
=======
|
||||
Regression testing will be arriving in the future, but for now there are only tests written in lua.
|
||||
|
||||
Variables:
|
||||
|
||||
* ``BUILD_TESTING`` (will build unit tests, in the future)
|
||||
* ``BUILD_TESTS`` (installs lua tests)
|
||||
|
||||
Usage::
|
||||
|
||||
cmake .. -DBUILD_TESTS:bool=ON
|
||||
cmake .. -DBUILD_TESTS=1
|
||||
|
||||
Plugins
|
||||
=======
|
||||
If you're doing plugin development.
|
||||
|
||||
Variable: ``BUILD_PLUGINS``
|
||||
|
||||
Usage::
|
||||
|
||||
cmake .. -DBUILD_PLUGINS:bool=ON
|
||||
cmake .. -DBUILD_PLUGINS=1
|
||||
|
||||
.. _building-documentation:
|
||||
|
||||
Documentation
|
||||
=============
|
||||
If you need to build documentation. Documentation can be built as HTML, and PDF,
|
||||
but there are also plain text files generated for in-game.
|
||||
|
||||
Variable: ``BUILD_DOCS``
|
||||
|
||||
Usage::
|
||||
|
||||
cmake .. -DBUILD_DOCS:bool=ON
|
||||
cmake .. -DBUILD_DOCS=1
|
||||
|
||||
|
||||
The generated documentation is stored in ``docs/html`` and ``docs/text`` (respectively)
|
||||
in the root DFHack folder, and they will both be installed to ``hack/docs`` when you
|
||||
install DFHack. The html and txt files will intermingle, but will not interfere with
|
||||
one another.
|
||||
@ -0,0 +1,14 @@
|
||||
.. _building-dfhack-index:
|
||||
|
||||
===============
|
||||
Building DFHack
|
||||
===============
|
||||
|
||||
Those seeking to compile the source code for DFHack, and or plugins, can refer to the following help pages.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
/docs/dev/compile/Dependencies
|
||||
/docs/dev/compile/Compile
|
||||
/docs/dev/compile/Options
|
||||
Loading…
Reference in New Issue