Editing v0.34:Installation

= Download =
__NOTOC__
You can always get Dwarf Fortress as [[Main:Toady One|Toady One]], the developer, released it from the [http://www.bay12games.com/dwarves/ Bay12 site] (check the top of the page).

You can also download the latest version here:
{{News/Mirrors/{{current/version}}}}
Windows users: Use the "Main" version unless there's some reason not to.
== Third-Party Packages ==

*[[Main:Lazy Newb Pack|Lazy Newb Pack]] (Windows Only) - the full game plus utilities and graphics sets in one big package
*[http://www.bay12forums.com/smf/index.php?topic=106790.0 MacNewbie] - same thing as LNP, just for Mac users
*[http://www.bay12forums.com/smf/index.php?topic=53180.0 Ironhand's Graphics Set] - improves the look of tiles
*[http://www.bay12forums.com/smf/index.php?topic=57557.0 Phoebus' Graphic Set] - another graphics set
*[[Utilities#Dwarf_Therapist|Dwarf Therapist]] - Utility for managing dwarves

The Dwarf Fortress community often creates custom [[Graphics set repository|graphics sets]] and [[Tilesets|tilesets]]. They're like graphical mods that make DF look prettier or just different. A lot of people pack the game folder with the tileset installed and everything already set up, so all you have to do is extract and play. Among the most popular of these are [http://www.bay12forums.com/smf/index.php?topic=53180.0 Ironhand's Graphics Set] and [http://www.bay12forums.com/smf/index.php?topic=57557.0 Phoebus' Graphic Set].

There's also the (Windows only) [[Main:Lazy Newb Pack|Lazy Newb Pack]] which has several tilesets and utilities gathered together to make it easier for new players to get started and to experiment with the different tilesets. The only disadvantage to downloading LNP is that there is usually some lag time between when a new version of the game is released and when the LNP is updated to include it. So, if a new version of the game has just been released it may not be in the LNP yet.

As for Mac, there is [http://www.bay12forums.com/smf/index.php?topic=106790.0 MacNewbie], which also contains some tilesets and utilities (even DFHack). There is also user-friendly init editor, which features colors and some most popular options to edit. Also, this pack is autoupdate-enabled so you don't need to check for updates manually.

Also see [[Utilities]] for a long list of utilities that people have created, including the incredibly useful [[Utilities#Dwarf_Therapist|Dwarf Therapist]], something that many people won't play the game without.

A guide to installing dwarf fortress using third party software can be found [http://www.youtube.com/watch?v=QmkPbGrH7VA&feature=plcp here].

= Installation =
:''Also see: [[System requirements]]''

== Windows ==

There is no installer for the game. Simply extract the archive file to a folder somewhere and run the game from within the folder.

Make sure to actually ''extract'' the archive; do not just open the archive and run the game from the window that appears. If you do this then it may appear to work, but your save game data will get discarded. This is the cause of many "my saved games keep getting deleted" complaints. The game also needs to be able to write to its own folder, so do '''not''' install it in C:\Program Files if you are running Windows Vista or later.

== Mac ==

The Mac version is not a single application bundle, but like the Windows version it consists of a folder containing the application along with data files and there is no installer. The entire folder can be dragged into the Applications folder or placed elsewhere. As with the Windows version, the game must be able to write to its own folder. The game may not run correctly without the Apple developer tools and X11 utility included in the OSX installation disk options.

To start the game execute the launch script "df".

=== OS X 10.7 Lion ===

When first running Dwarf Fortress on 10.7 Lion, you may be startled to discover that Terminal crashes without so much as a by-your-leave. Don't worry; Dwarf Fortress will still run on Lion. The issue lies in the libraries; they haven't changed from the ones in Snow Leopard, but their naming scheme has. The fix is a quick one. Open up the "df" launch script in a text editor of your choice (TextEdit is the default), and locate the following lines:

:export DYLD_FALLBACK_LIBRARY_PATH=${PWD}/libs<br/>
:export DYLD_FALLBACK_FRAMEWORK_PATH=${PWD}/libs

Change them to read as follows:

:export DYLD_LIBRARY_PATH=${PWD}/libs<br/>
:export DYLD_FRAMEWORK_PATH=${PWD}/libs

With the change, Dwarf Fortress should run normally.

== Linux ==

The Linux version of the game is shipped as a compiled 32-bit x86 (Intel/AMD) application. It will also run on a system with a 64-bit AMD or Intel processor and a 64-bit kernel, provided that you have the (32-bit) shared libraries available that the program needs.

Dwarf Fortress for Linux is meant to be run from a terminal (command-line) interface, and so the instructions here will assume you know how to login and get to a command prompt.  At least in the default mode, however, Dwarf Fortress is an X client (graphical desktop) program, so you should be in a terminal inside an X session before starting the game.  Dwarf Fortress will create a new X window outside of the terminal window, so don't worry about the size of the terminal.

* '''Unpacking''': Dwarf Fortress is shipped as a (bzip2) compressed tar archive.  It will extract into a new directory called '''df_linux'''.  So, cd to wherever you want the game to be unpacked, and then run '''tar xjf /path/to/df_XX_YY_linux.tar.bz2''' (where df_XX_YY_linux.tar.bz2 is the filename).  Then run '''cd df_linux''' to change into the new directory.
* '''Running''': Run '''./df''' to execute the Dwarf Fortress wrapper script.
* '''Troubleshooting''': If you get an error like this:
 ./libs/Dwarf_Fortress: error while loading shared libraries: libSDL_image-1.2.so.0:
 cannot open shared object file: No such file or directory
: it means that your system is missing one or more shared libraries.  See below.
* '''Upgrading''': Since every new version of Dwarf Fortress unpacks in a directory named '''df_linux''' you have to manage upgrades yourself. As on all systems, you should '''not''' unpack a new version of DF on top of an old version's directory -- this will cause things to break, usually in subtle and mysterious ways.  Instead, you should either delete or rename the old '''df_linux''' directory first, before extracting the new version.

Alternatively, downloading the windows version and running it with the wine emulator works fine. This also avoids any issues with 32-bit versus 64-bit mode.

If you get errors, it is likely that others will have had the same problem; Try searching the bay12games forum with the error message.

=== 32-bit vs. 64-bit systems ===

Modern desktop PCs (of the Intel/AMD persuasion) contain CPUs that can run in either 32-bit or 64-bit modes.  When you install Linux, you choose one of these architectures.  The programs on your system will then be compiled either for the 32-bit (i386, x86) arch, or the 64-bit (amd64, x86_64) arch.  If you've forgotten which one you have, you can check:

 $ file /bin/ls
 /bin/ls: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs),
 for GNU/Linux 2.6.18, stripped

The above would indicate a 64-bit system.  Here's one from a 32-bit system:

 $ file /bin/ls
 /bin/ls: ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV), dynamically linked (uses shared libs),
 for GNU/Linux 2.6.18, stripped

Dwarf Fortress is compiled for 32-bit systems, so if you're on a 32-bit system, things will be slightly easier.  If you are getting errors about missing SDL_image libraries (etc.) then you simply need to install them.  Use your distribution's package manager for this -- details will be extremely distribution-specific.  You don't need the development versions of the packages with the headers (although that won't hurt) -- you just need the runtime versions, with the actual shared libraries.

If you're on a 64-bit system, then things get a bit trickier.  Since DF is a 32-bit application, it needs 32-bit versions of the shared libraries.  Some Linux distributions provide these in one or more packages that you can download.  For example, in Debian, the ia32-libs package contains most of the common 32-bit libraries, including libSDL. If your distribution does not include these, then you may have to supply them manually.

==== How-to for Debian and similar ====

On Ubuntu/Debian and it's derivatives, installing 32-bit libraries is as easy as appending ":i386" to the name of the library.  For libsdl-image and libsdl-ttf, this amounts to:

  $ sudo dpkg --add-architecture i386
  $ sudo apt-get update
  $ sudo apt-get install libsdl-image1.2:i386 libsdl-ttf:i386 libgtk2.0-0:i386 libjpeg62:i386


etc.. Alternatively, you can use 

  $ sudo apt-get install ia32-libs

to install a bunch of 32-bit packages which includes those needed for Dwarf Fortress.

'''Sound'''

After doing this, DF will run, but will complain that it cannot find the OpenAL library and cannot play sounds, even when OpenAL (i386) has been installed. This is due to a bug/feature in which there is no link from the name of the library that DF is looking for ("libopenal.so") to its implementation ("libopenal.so.1" - technically another link). To fix this, simply provide the necessary links in DF's own ''libs'' directory:

  $ cd df_linux/libs
  $ ln -s /usr/lib/i386-linux-gnu/libopenal.so.1 ./libopenal.so
  $ ln -s /usr/lib/i386-linux-gnu/libsndfile.so.1 ./libsndfile.so

==== Manually installing 32-bit libraries ====

If you do need to manually install the libraries, then the first step is to figure out where you will be putting them.  Check to see where your other 32-bit libraries are already installed; for example, on Debian, some are in /lib32 and others are in /usr/lib32.  Since libSDL is in /usr/lib32 on a Debian system, that's where we'll want to put libSDL_image and libSDL_ttf.  On other distributions, the path could be different.

The second step is to get the 32-bit libraries.  You can typically do this by downloading them directly from your distribution's 32-bit package repository.  Again using Debian as our example, we can perform a search at http://packages.debian.org/ for files containing the word libSDL_image for the Intel x86 architecture.  This takes us to [http://packages.debian.org/search?searchon=contents&keywords=libSDL_image&mode=filename&suite=stable&arch=i386 a results page] from which we can proceed to [http://packages.debian.org/squeeze/libsdl-image1.2 the libsdl-image1.2 package page] with a list of download links arranged by architecture.  Grab the i386 package from here, and repeat this for the libSDL_ttf package, and whatever other library you are missing.  Store these package files somewhere convenient.

The third step is to extract the libraries from the packages and get them in the proper location.  You probably ''won't'' be able simply to install the packages using your package manager, because they are for the wrong architecture.  Instead, you'll probably have to extract them by hand.  The steps for doing this are distribution-specific, so when in doubt consult your distribution's help resources.  I'll show the steps for a .deb package.

* cd into some temporary working directory such as /tmp
* Extract the files from the .deb archive, which is in ar(1) format:
  ar x /path/to/libsdl-image1.2*_i386.deb
: This creates three files: debian-binary, control.tar.gz and data.tar.gz.  We only care about data.tar.gz.
* Extract data.tar.gz:
  tar xzf data.tar.gz
: This creates a subdirectory named usr with various files inside it.  We only care about usr/lib/libSDL_image-1.2.so.0.8.2 (or whatever precise version yours has).
* Move the shared library into place:
  sudo mv usr/lib/libSDL_image-1.2.so.* /usr/lib32/
* Create a symlink to it:
  cd /usr/lib32
  sudo ln -s libSDL_image-1.2.so.0.* libSDL_image-1.2.so.0
  cd -

Repeat this for libSDL_ttf and whatever other libraries are required.

'''NOTE''': If you get the error that libsndfile.so is not found, you must use the following:
  find */libsndfile.so*
cd to the correct directory, then use ln as shown above.


==== "Not found: /data/art/mouse.png" and similar errors ====

Another common difficulty with 64bit systems is related to the art packs. When DF is run on most (?all) 64bit Unix systems, it generates error messages related to the PNG variants of the art files, errors which prevent the game from starting.

To solve this problem, you must first edit the ''/data/init/init.txt'' file and set the game to use the BMP variants of the art files, instead of the default PNG. This should solve all the error messages except for one: "''Not found: data/art/mouse.png''" since there is no setting in the ''init'' files to change it. The workaround for this is to edit the ''Dwarf_Fortress'' file found in the ''/your/path/df_linux/libs'' folder which contains the setting for the mouse cursor.
If you don't know how to do that, you can try this:
* cd to the ''/df_linux/libs'' folder
* open ''Dwarf_Fortress'' in ''vi'' or any other editor of your choise:
  vi ./Dwarf_Fortress
: This opens the file for editing (text mode). If you are not familiar with ''vi'', it would be a good idea to follow these steps exactly and not press any other keys since they all activate specific commands. If you do press a key though, you can press the ''ESC key'' a few times to cancel the command.
* With vi open, write the following string and press ''Enter'':
  /mouse
: This will search for all the strings that contain the word "mouse" and place the cursor on the first match. Pressing the ''n key'' will cycle through all the matches.
* Press the ''n'' key until the cursor moves to the desired string, which is "''data/art/mouse.png''". If you accidentally move past the string, you can cycle back through the matched strings using the ''N key'' (shift + n).
* Once you find the right string, you will have to move the cursor over the "p" in "[..]/mouse.<b>p</b>ng". You do that by pressing the ''l key'' which will move the cursor to the right. There is also the ''h key'' to move the cursor to the left, in case you move past it.
* With the cursor in the right position press the following key sequence:
  xxxibmp
: This will replace the ''.png'' extension with the ''.bmp'' one which solves the problem of the missing ''/data/art/mouse.png'' error.
* All there is left to do is to save the modifications to the file and quit ''vi''. For that, press the ''ESC key'' once or twice and then press the following key sequence after which you press ''Enter'':
  :wq
: This saves the changes and quits 'vi'

Now the game should work properly. Have fun!

= Documentation =

Fortunately the documentation on this wiki is very detailed and extensive. You may want to start out with:
* [[Tutorials]]
* [[Quickstart_guide|Fortress Mode Quickstart Guide]]
* [[Adventure mode quick start|Adventure Mode Quickstart Guide]]

Then move on to:
* [[Dwarf fortress mode|Fortress Mode reference]]
* [[Adventure mode|Adventure Mode reference]]
* [[Special:Search|Searching]] the wiki

{{Getting Started}}