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.
Editing Mod
Jump to navigation
Jump to search
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
If you are creating a redirect to the current version's page, do not use any namespace. For example: use #REDIRECT [[Cat]], not #REDIRECT [[Main:Cat]] or #REDIRECT [[cv:Cat]]. See DF:Versions for more information.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
| − | + | = Mods = | |
| − | + | == Installing Mods == | |
| − | + | Mods can be acquired using the [https://steamcommunity.com/app/975370/workshop/ steam workshop] (if using Steam version), a manual download from [[Bay 12 Forums]] or third party websites (like [https://dffd.bay12games.com/ DFFD]), or by [[Modding|creating]] one yourself. | |
| − | + | Users of the Steam version can subscribe to mods on Steam Workshop, once the download is complete they will be available when creating a new world automatically. Otherwise, manually download the mod, then place the mod zip file or the unzipped mod folder into the Dwarf Fortress [[mods folder]] (if this folder doesn't exist, you can create it.) | |
| − | + | == Enabling Mods == | |
| + | [[File:mod menu.png|thumb|]] | ||
| − | + | Mods can be enabled when you [[World generation|create a new world]]. When creating a world and choosing its initial parameters, if you have a mod available, there should be a '''Mods''' button at the bottom of the screen. Pressing this will let you select which mods you'd like to enable and what the load order should be. You should put mods at the end of the mod list after the vanilla objects if you don't have any further information, so that they can reference vanilla objects after those are loaded. | |
| − | [[ | ||
| − | + | : Note: Unlike the previous versions of Dwarf Fortress, mods no longer live inside save files and must be installed on every computer where saves using those mods are going to be loaded. Once a world is created that uses mods, then the game will copy the mod to the <code>data/installed_mods</code> folder. That is the version that the game actually uses. | |
| − | + | = Modding = | |
| − | + | Dwarf Fortress supports mods in the form of new objects and tiles. Each mod is a zip file or unzipped folder with the required format (see below.) | |
| − | |||
| − | + | == Mod Format== | |
| − | |||
| − | + | Mods contain an info.txt file and either an "objects" folder or a "graphics" folder (or both.) All of the vanilla objects in the game now use this format. | |
| − | |||
| − | |||
| − | + | [[File:Folder-orange.svg|20px|link=]] Mod Name | |
| − | + | <br> ├ [[File:Text-x-generic.svg|20px|link=]] info.txt | |
| − | + | <br> ├ [[File:Text-x-generic.svg|20px|link=]] preview.png | |
| − | + | <br> ├ [[File:Folder.svg|20px|link=]] objects | |
| − | + | <br> └ [[File:Folder.svg|20px|link=]] graphics | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Mod info === | === Mod info === | ||
| − | |||
| − | Each mod | + | Each mod has a <code>info.txt</code>. It has a few fields defining basic information about the mod and can be edited using any text editor (like notepad++). See Example: |
{{code| | {{code| | ||
| − | [ID: | + | [ID:vanilla_items] |
| − | [NAME: | + | [NAME:Vanilla Items] |
[NUMERIC_VERSION:5001] | [NUMERIC_VERSION:5001] | ||
[DISPLAYED_VERSION:50.01] | [DISPLAYED_VERSION:50.01] | ||
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:5001] | [EARLIEST_COMPATIBLE_NUMERIC_VERSION:5001] | ||
[EARLIEST_COMPATIBLE_DISPLAYED_VERSION:50.01] | [EARLIEST_COMPATIBLE_DISPLAYED_VERSION:50.01] | ||
| − | [AUTHOR: | + | [AUTHOR:Bay 12 Games] |
| − | [DESCRIPTION: | + | [DESCRIPTION:These are the default Dwarf Fortress items.] |
| − | [STEAM_TITLE: | + | [STEAM_TITLE:Test Descriptors] |
| − | [STEAM_DESCRIPTION: | + | [STEAM_DESCRIPTION:Some test object definitions for shapes and colors.] |
[STEAM_TAG:mod] | [STEAM_TAG:mod] | ||
[STEAM_KEY_VALUE_TAG:test:stuff] | [STEAM_KEY_VALUE_TAG:test:stuff] | ||
| Line 68: | Line 52: | ||
}} | }} | ||
| − | Only <code>ID</code> and <code>NAME</code> are required to | + | Only <code>ID</code> and <code>NAME</code> are required to appears in the in-game mod menu. |
STEAM tags are only used by Steam. | STEAM tags are only used by Steam. | ||
| − | * The <code>STEAM_FILE_ID</code> used to identify the mod in the Workshop. This is automatically managed when uploading to Steam the first time | + | * The <code>STEAM_FILE_ID</code> used to identify the mod in the Workshop. This is automatically managed when uploading to Steam the first time. And required if you wish to update an existing Steam Workshop mod. |
| − | * The <code>STEAM_TAG</code> and <code>STEAM_KEY_VALUE_TAG</code> are used by | + | * The <code>STEAM_TAG</code> and <code>STEAM_KEY_VALUE_TAG</code> are used by Steams search engine and the categorization. You can use as many entries you want, use a separate tag for each one. |
| − | * You can also create a thumbnail for your mod | + | * You can also create a thumbnail for your mod by creating an image called <code>preview.png</code> in the same level as your info.txt file. This image will become the thumbnail when the mod is uploaded to steam workshop. The image should be less than 1MB in size. |
=== Objects and graphics folder === | === Objects and graphics folder === | ||
| − | + | objects folder contains objects exactly the same as objects from previous versions of Dwarf Fortress. It's beyond the scope of this short guide to go into what specific tags do, but the vanilla objects and previous mods by members of the community will give you plenty of examples to work with. | |
| − | |||
| − | |||
| − | + | Sound and Music files are stored in the <code>*.ogg/</code> format within the [[Game folder]]/sound/ subfolders. You can replace the existing ogg files with different ones. That has to be performed manually and isn't actually supported by the game. You can also change some of the definitions of when certain musical cues are played, since those are defined in raw files. However, you can't add new music or sounds other than replacing what's already there. | |
| − | + | == Publish on Steam Workshop == | |
| − | |||
| − | |||
To upload a mod to Steam Workshop, you need to add STEAM tags to the <code>info.txt</code> file (see above.) Afterward, you put the unzipped mod folder in the "<code>mods/mod_upload</code>" folder. Then select Mods from the title menu, and upload your mods using the button you'll see there. Other Steam users will be able to subscribe to your mod immediately once it is uploaded. | To upload a mod to Steam Workshop, you need to add STEAM tags to the <code>info.txt</code> file (see above.) Afterward, you put the unzipped mod folder in the "<code>mods/mod_upload</code>" folder. Then select Mods from the title menu, and upload your mods using the button you'll see there. Other Steam users will be able to subscribe to your mod immediately once it is uploaded. | ||
Once the upload process is completed successfully, you'll find a <code>[STEAM_FILE_ID:#########]</code> appended to your info.txt. Make sure this entry is included for future uploads if you want to make changes to your mod and have it overwrite the existing entry on the workshop. Otherwise you'll create a new entry every time you upload. | Once the upload process is completed successfully, you'll find a <code>[STEAM_FILE_ID:#########]</code> appended to your info.txt. Make sure this entry is included for future uploads if you want to make changes to your mod and have it overwrite the existing entry on the workshop. Otherwise you'll create a new entry every time you upload. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[Category:Modding]] | [[Category:Modding]] | ||