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 26: | Line 26: | ||
If a [[save]] is using a mod that's been updated, and is currently using an older version of that mod, the player will be prompted about this when a save is loading. When this happens, you have the choice of simply updating the mod, updating ''all'' mods at once, continuing to use the older version of the mod in question without updating, selecting the previous task but not updating ''any'' possibly outdated mods or simply returning to the title screen. | If a [[save]] is using a mod that's been updated, and is currently using an older version of that mod, the player will be prompted about this when a save is loading. When this happens, you have the choice of simply updating the mod, updating ''all'' mods at once, continuing to use the older version of the mod in question without updating, selecting the previous task but not updating ''any'' possibly outdated mods or simply returning to the title screen. | ||
| − | If a save is using a mod that is missing, the player will be prompted about this when a save is loading. When this happens, try to reinstall the mods | + | If a save is using a mod that is missing, the player will be prompted about this when a save is loading. When this happens, try to reinstall the mods. Either by manually downloading them again or in case of Steam Workshop making sure you are subscribed and if you do by unsubscribing and subscribing again. |
== Modding == | == Modding == | ||
| Line 46: | Line 46: | ||
{{main|Mod info token}} | {{main|Mod info token}} | ||
| − | Each mod must have | + | Each mod must have a <code>info.txt</code> at the root of your mod folder. It has a few fields defining basic metadata information about the mod and can be edited using any text editor (like notepad++). See Example: |
{{code| | {{code| | ||
| Line 72: | Line 72: | ||
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, and required if you wish to update an existing Steam Workshop mod. | * 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 Steam's search engine | + | * The <code>STEAM_TAG</code> and <code>STEAM_KEY_VALUE_TAG</code> are used by Steam's search engine and the categorization. You can use as many entries as you want, use a separate tag for each one. |
* 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. | * 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 === | ||
| − | + | At the root of your mod folder you can have a <code>objects\</code> and <code>graphics\</code> folder, this is where all the [[raw file]]s or [[graphics]] goes (exactly the same as objects from previous versions of Dwarf Fortress) allowing you to tweak or add new content for the game. 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. See: [[modding]]. | |
| − | The graphics filenames are not important | + | The graphics filenames are not important, furthermore they can be arbitrarily nested into other sub-folders to help you organize your mod content. |
== Publishing mods == | == Publishing mods == | ||
| − | There are two official platforms for publishing ''Dwarf Fortress'' mods, recommended because it's easy for people to find them there. These are [https://steamcommunity.com/app/975370/workshop/ | + | There are two official platforms for publishing ''Dwarf Fortress'' mods, recommended because it's easy for people to find them there. These are [https://steamcommunity.com/app/975370/workshop/ Steam Workshop] and [https://dffd.bay12games.com/ the Dwarf Fortress File Depot (DFFD)]. |
=== Publishing on Steam Workshop === | === Publishing on Steam Workshop === | ||