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 "Info.txt file"
Jump to navigation
Jump to search
| Line 7: | Line 7: | ||
└ [[File:Folder.svg|20px|link=]] graphics | └ [[File:Folder.svg|20px|link=]] graphics | ||
| − | This page is specifically about the '''info.txt''' file. | + | 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. |
| + | |||
| + | === Mod info === | ||
| + | {{main|Mod info token}} | ||
| + | |||
| + | 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| | ||
| + | [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:#########] | ||
| + | }} | ||
== See Also == | == See Also == | ||
Revision as of 22:05, 25 January 2023
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 └
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.
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++). See Example:
[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:#########]