v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Game folders and files"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
m (→‎Savegame folder: Add location for Steam Deck.)
(→‎Game user data folder: expanded on benefits of both options and moved to paragraph)
 
(27 intermediate revisions by 8 users not shown)
Line 1: Line 1:
Default location depends on the game version, platform or operating system. It is possible that users change the install drive or directory, thus these locations may vary.
+
{{av}}
 +
The location of Dwarf Fortress's '''game folders''' depends on the game version, preferences, and operating system. It is also possible for users to change the install drive or directory, like in Steam settings, thus these locations may vary.
  
 +
Non-portable, user specific data folders were added in version 52.01, and allow different users to maintain their own settings and saves.
 
<!--
 
<!--
 
[[File:Windows logo - 2012.svg|18px|link=]]  
 
[[File:Windows logo - 2012.svg|18px|link=]]  
Line 6: Line 8:
 
[[File:Apple logo dark grey.svg|18px|link=]]  
 
[[File:Apple logo dark grey.svg|18px|link=]]  
 
-->
 
-->
 +
==Game installation folder==
 +
The game's installation folder is where all the game's content is stored. You might want to go to this folder to browse [[raw file]]s, or to check logs.
  
==Game folder==
+
* '''Dwarf Fortress Classic''' is [[Installation|distributed]] in a zip archive. Depending on the operating system, the game folder is either <code>df_##_##_win</code> (with the version number, or the name chosen for the folder during extraction), <code>df_osx</code> or <code>df_linux</code> and will be located where you choose to [[installation|extract it]]. This is where the game is run from. For example: <code>C:\Games\Dwarf Fortress\</code>
The game's installation folder is where all the game's content is stored. You might want to go to this folder for [[modding]] or [[screenshot]]s, or to copy, modify or delete some [[#Savegame Folder|saves]].  
+
* '''Steam''': The default locations are listed below. You can also find it through Steam by right-clicking "Dwarf Fortress" in your library and choosing Properties, then go to the Local files tab and click Browse local files. If you set a custom library location in Steam, it will end up there instead.
 +
** '''Windows''': <code>C:\Program Files (x86)\Steam\steamapps\common\Dwarf Fortress\</code>
 +
** '''Linux''': <code>~/.local/share/Steam/steamapps/common/Dwarf Fortress/</code>
 +
* '''Itch.io''': is also distributed as an archive file, so where you chose to extract it.
  
* Dwarf fortress Classic is [[Installation|distributed]] in a zip archive. Depending on the operating system the game folder is either <code>df_##_##_win</code> (with the version number, or the name chosen for the folder during extraction), <code>df_osx</code> or <code>df_linux</code> and will be located where you choose to [[installation|extract it]]. Essentially its where you run the game from. For example: <code>C:\Games\Dwarf Fortress\</code>
+
== Game user data folder ==
 +
The game's user data folder contains the saved games, preferences, and mods for the game. The location of this depends on the [[Settings#Portable mode|portable mode setting]], defaulting to a non-portable, user-specific folder{{v|52.01}}. Changing it to YES creates the empty file ``prefs\portable.txt``, changing back to NO removes it; manually creating or removing the file changes the setting.
  
* Steam: The default locations are listed below. You can also find it through the app by right-click Dwarf Fortress in the Steam library and choose Properties, then go to the Local files tab and click Browse local files.
+
Benefits of portable mode include: allows the game to be installed on an external drive and run on different computers, or allows to have multiple versions of the game installed using different data. Benefits of user-specific mode include: multiple users can use the same install each with their own custom data, and having updating with the [[Bay 12 Games]] and itch.io downloads be simply extracting the archives to a new folder.
:* Windows x86: <code>C:\Program Files\Steam\steamapps\Dwarf Fortress\</code>
 
:* Windows x86 (alt Windows 10): <code>C:\Program Files (x86)\Steam\steamapps\common\Dwarf Fortress\</code>
 
:* Windows x64: <code>C:\Program Files (x86)\Steam\steamapps\Dwarf Fortress\</code>
 
* Itch.io: The default location is <code>%APPDATA%\itch\apps\Dwarf Fortress\</code> {{Verify}}
 
  
Note: On windows <code>%APPDATA%</code> is a hidden folder that points to <code>C:\Users\(Username)\AppData</code>. You can use winkey+R and type 'appdata' to quickly jump there.
+
* '''Non-Portable''':
 +
**Windows: ``C:\Users\(Your username)\AppData\Roaming\Bay 12 Games\Dwarf Fortress\``
 +
**Linux: ``/home/(Your username)/.local/share/Bay 12 Games/Dwarf Fortress/``
 +
* '''Portable''':
 +
**All folders are located within the ''Dwarf Fortress'' game installation folder above
 +
Note: On Windows, ``%APPDATA%`` is an environment variable that points to ``C:\Users\(Username)\AppData\Roaming``. You can use winkey+R and type '%appdata%' to quickly jump there.
  
== Savegame folder ==
+
=== Saves folder ===
:''Further information: [[Saved game folder]]''
+
{{main|Saved game folder}}
The Save game folder contains the save games and backup saves from the game.
+
Saves are stored in the ``save`` folder in the above user data folder, each folder in that folder is a save (except ``current`` which is used by the game and should be left alone). All the files in each folder are part of the save. The saves list for each world in game has a Files button that opens a menu that allows you to delete the save or open the folder location.{{version|52.03}}
  
* Classic: The folder is located within Dwarf Fortress gamefolder <code>(gamefolder)\saves\</code>. Note: On a Windows system, if the game was installed in the 'Program Files' subdirectory, the folder is instead located at <code>C:\Users\(Your username)\AppData\Local\VirtualStore\Program Files\Dwarf Fortress\save</code>.
+
=== Mods folders ===
* Steam: <code>C:\Users\(Your username)\AppData\Local\VirtualStore\Program Files\Dwarf Fortress\save</code>. (If there's nothing here, check the "Classic" location above)
+
:''Further information: [[Modding]]''
* Steam Deck: <code>/home/deck/.local/share/Steam/steamapps/common/Dwarf Fortress/save</code>
+
There are two folders where mods are stored, both in the above user data folder.
* Itch.io: <code>???</code>
 
  
== Mod folder ==
+
* Downloaded mods are stored in ``mods``
:''Further information: [[Modding]]''
+
* Mods actually used in saves are stored in ``data\installed_mods``
The mod folder is the game directory where mods are stored.
+
When sharing modded saves, you probably want to include the installed mods folder.
  
* Classic: <code>(gamefolder)\mods\</code>
+
=== Settings folder ===
* Steam: <code>C:\Users\(Your username)\AppData\Local\VirtualStore\Program Files\Dwarf Fortress\Mods</code>.
+
{{main|Settings}}
 +
Called settings in game, user preferences are stored in the ``prefs`` folder in the above user data folder. Many of the defaults are stored in the ``data\init`` folder in the installation folder.
  
== Other ==
+
== Key ==
 
{|  
 
{|  
 
| [[File:Folder-orange.svg|20px|link=]] Dwarf Fortress  
 
| [[File:Folder-orange.svg|20px|link=]] Dwarf Fortress  
| : Installation folder
+
| : Game folder
 +
|-
 +
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] crashlogs       
 +
| : Created by the game when needed, the files it places here can be uploaded to the [https://kitfoxgames.notion.site/How-to-Report-Bugs-in-Dwarf-Fortress-Updated-Nov-2023-b5e2ca19dabe408897d1c2669599b7a2 Dwarf Fortress Bug Tracker] or the [[Kitfox Games]] discord.
 
|-
 
|-
 
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] data         
 
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] data         
| :
+
| : Contains game content.
 
|-
 
|-
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] art         
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] art         
| :
+
| : Any images not loaded from vanilla graphics modules, for the main menu and classic ASCII mode.
 
|-
 
|-
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] init         
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] init         
| :
+
| : Default game settings.
 
|-
 
|-
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] installed_mods  
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] installed_mods  
| :
+
| : Folder of mod copies used when loading a world, actual location used depends on above portable mode setting.
 
|-
 
|-
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] sound       
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] sound       
Line 57: Line 69:
 
|-
 
|-
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] vanilla     
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] vanilla     
| : Contains all the raw files
+
| : Contains all the vanilla modules and raw files.
 +
|-
 +
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] licenses       
 +
| : Contains licenses for software libraries used in the game.
 
|-
 
|-
 
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] mods         
 
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] mods         
| : Folder for manually installed mods.
+
| : Folder for downloaded mods before being used.
 
|-
 
|-
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] mod_upload   
 
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] mod_upload   
| : Folder for uploading mods to steam.
+
| : Folder for uploading mods to Steam.
 
|-
 
|-
 
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] prefs         
 
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] prefs         
| : Contains all game setting files
+
| : Contains current game settings files, actual location used depends on above portable mode setting.
 +
|-
 +
| &emsp;&emsp;&emsp;&#x25cf; [[File:Folder.svg|20px|link=]] macros
 +
| : Folder where macros are saved, actual location used depends on above portable mode setting.
 
|-
 
|-
 
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] save         
 
| &emsp;&#x25cf; [[File:Folder.svg|20px|link=]] save         

Latest revision as of 05:25, 7 October 2025

This article is about the current version of DF.
Note that some content may still need to be updated.

The location of Dwarf Fortress's game folders depends on the game version, preferences, and operating system. It is also possible for users to change the install drive or directory, like in Steam settings, thus these locations may vary.

Non-portable, user specific data folders were added in version 52.01, and allow different users to maintain their own settings and saves.

Game installation folder[edit]

The game's installation folder is where all the game's content is stored. You might want to go to this folder to browse raw files, or to check logs.

  • Dwarf Fortress Classic is distributed in a zip archive. Depending on the operating system, the game folder is either df_##_##_win (with the version number, or the name chosen for the folder during extraction), df_osx or df_linux and will be located where you choose to extract it. This is where the game is run from. For example: C:\Games\Dwarf Fortress\
  • Steam: The default locations are listed below. You can also find it through Steam by right-clicking "Dwarf Fortress" in your library and choosing Properties, then go to the Local files tab and click Browse local files. If you set a custom library location in Steam, it will end up there instead.
    • Windows: C:\Program Files (x86)\Steam\steamapps\common\Dwarf Fortress\
    • Linux: ~/.local/share/Steam/steamapps/common/Dwarf Fortress/
  • Itch.io: is also distributed as an archive file, so where you chose to extract it.

Game user data folder[edit]

The game's user data folder contains the saved games, preferences, and mods for the game. The location of this depends on the portable mode setting, defaulting to a non-portable, user-specific folderv52.01. Changing it to YES creates the empty file prefs\portable.txt, changing back to NO removes it; manually creating or removing the file changes the setting.

Benefits of portable mode include: allows the game to be installed on an external drive and run on different computers, or allows to have multiple versions of the game installed using different data. Benefits of user-specific mode include: multiple users can use the same install each with their own custom data, and having updating with the Bay 12 Games and itch.io downloads be simply extracting the archives to a new folder.

  • Non-Portable:
    • Windows: C:\Users\(Your username)\AppData\Roaming\Bay 12 Games\Dwarf Fortress\
    • Linux: /home/(Your username)/.local/share/Bay 12 Games/Dwarf Fortress/
  • Portable:
    • All folders are located within the Dwarf Fortress game installation folder above

Note: On Windows, %APPDATA% is an environment variable that points to C:\Users\(Username)\AppData\Roaming. You can use winkey+R and type '%appdata%' to quickly jump there.

Saves folder[edit]

Main article: Saved game folder

Saves are stored in the save folder in the above user data folder, each folder in that folder is a save (except current which is used by the game and should be left alone). All the files in each folder are part of the save. The saves list for each world in game has a Files button that opens a menu that allows you to delete the save or open the folder location.v52.03

Mods folders[edit]

Further information: Modding

There are two folders where mods are stored, both in the above user data folder.

  • Downloaded mods are stored in mods
  • Mods actually used in saves are stored in data\installed_mods

When sharing modded saves, you probably want to include the installed mods folder.

Settings folder[edit]

Main article: Settings

Called settings in game, user preferences are stored in the prefs folder in the above user data folder. Many of the defaults are stored in the data\init folder in the installation folder.

Key[edit]

Folder-orange.svg Dwarf Fortress : Game folder
 ● Folder.svg crashlogs : Created by the game when needed, the files it places here can be uploaded to the Dwarf Fortress Bug Tracker or the Kitfox Games discord.
 ● Folder.svg data : Contains game content.
   ● Folder.svg art : Any images not loaded from vanilla graphics modules, for the main menu and classic ASCII mode.
   ● Folder.svg init : Default game settings.
   ● Folder.svg installed_mods : Folder of mod copies used when loading a world, actual location used depends on above portable mode setting.
   ● Folder.svg sound : Contains all audio and music files used in the game.
   ● Folder.svg vanilla : Contains all the vanilla modules and raw files.
 ● Folder.svg licenses : Contains licenses for software libraries used in the game.
 ● Folder.svg mods : Folder for downloaded mods before being used.
   ● Folder.svg mod_upload : Folder for uploading mods to Steam.
 ● Folder.svg prefs : Contains current game settings files, actual location used depends on above portable mode setting.
   ● Folder.svg macros : Folder where macros are saved, actual location used depends on above portable mode setting.
 ● Folder.svg save : Contains all save game files.
Settings
Gameplay settings
Log files
Other