- 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.
Difference between revisions of "Info.txt file"
| Line 19: | Line 19: | ||
=== Examples === | === Examples === | ||
| + | ==== Example Bay 12 ==== | ||
| + | |||
| + | This is the example found at [[https://bay12games.com/dwarves/modding_guide.html Bay 12 Games]] | ||
| + | |||
| + | [ID:vanilla_items] | ||
| + | [NUMERIC_VERSION:5001] | ||
| + | [DISPLAYED_VERSION:50.01] | ||
| + | [EARLIEST_COMPATIBLE_NUMERIC_VERSION:5001] | ||
| + | [EARLIEST_COMPATIBLE_DISPLAYED_VERSION:50.01] | ||
| + | [AUTHOR:Mary Lee] | ||
| + | [NAME:Vanilla Items] | ||
| + | [DESCRIPTION:These are the default Dwarf Fortress items.] | ||
==== Example 1 ==== | ==== Example 1 ==== | ||
| Line 59: | Line 71: | ||
''Note that you should remove the last token "STEAM_FILE_ID" as it will be autogenerated. Remove the [STEAM_FILE_ID:###] tag since that is unique for every mod and generates automatically whenever you upload your mod to the workshop'' | ''Note that you should remove the last token "STEAM_FILE_ID" as it will be autogenerated. Remove the [STEAM_FILE_ID:###] tag since that is unique for every mod and generates automatically whenever you upload your mod to the workshop'' | ||
| − | |||
| − | |||
== See Also == | == See Also == | ||
Revision as of 22:12, 25 January 2023
This page is specifically about the info.txt file. A lot of what is here is redundant; it can also be found at the comprehensive Mod page.
Directory Structure
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 too use this format. Your mod folder should look something like this:
Mod Name ├
info.txt ├
objects └
Mod Info
Each mod must have a info.txt 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++).
Examples
Example Bay 12
This is the example found at [Bay 12 Games|https://bay12games.com/dwarves/modding_guide.html Bay 12 Games]
[ID:vanilla_items] [NUMERIC_VERSION:5001] [DISPLAYED_VERSION:50.01] [EARLIEST_COMPATIBLE_NUMERIC_VERSION:5001] [EARLIEST_COMPATIBLE_DISPLAYED_VERSION:50.01] [AUTHOR:Mary Lee] [NAME:Vanilla Items] [DESCRIPTION:These are the default Dwarf Fortress items.]
Example 1
[ID:wiki_example]
[NAME:Wiki Example Mod]
[NUMERIC_VERSION:5001]
[DISPLAYED_VERSION:50.01]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:5001]
[EARLIEST_COMPATIBLE_DISPLAYED_VERSION:50.01]
[AUTHOR:Dwarf Fortress Wiki]
[DESCRIPTION:This is an example mod. This text shows up in-game.]
[STEAM_TITLE:Wiki Example Mod]
[STEAM_DESCRIPTION:This text shows up on Steam Workshop.]
[STEAM_TAG:mod]
[STEAM_KEY_VALUE_TAG:test:stuff]
[STEAM_METADATA:metadata test]
[STEAM_CHANGELOG:Made some changes. Shown in 'Change Notes' tab.]
[STEAM_FILE_ID:#########]
Example 2
[ID:example_mod]
[NUMERIC_VERSION:1]
[DISPLAYED_VERSION:1.0.0]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:1]
[EARLIEST_COMPATIBLE_DISPLAYED_VERSION:1.0.0]
[AUTHOR:Author]
[NAME:Example Mod]
[DESCRIPTION:This is just an empty example mod.]
[STEAM_TITLE:Example Mod]
[STEAM_DESCRIPTION:This is just an empty example mod.]
[STEAM_TAG:example]
[STEAM_FILE_ID:2905754195]
Note that you should remove the last token "STEAM_FILE_ID" as it will be autogenerated. Remove the [STEAM_FILE_ID:###] tag since that is unique for every mod and generates automatically whenever you upload your mod to the workshop