Editing 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.

== 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:

 [[File:Folder-orange.svg|20px|link=]] Mod Name
  ├ [[File:Text-x-generic.svg|20px|link=]] info.txt
  ├ [[File:Text-x-generic.svg|20px|link=]] preview.png
  ├ [[File:Folder.svg|20px|link=]] objects
  └ [[File:Folder.svg|20px|link=]] graphics



== 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++ or Subline Text). 

=== Examples ===

The three examples below are largely identical.

==== Example Bay 12 ====

''This is the example found at [https://bay12games.com/dwarves/modding_guide.html Bay 12 Games].''

{{code|
[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 DF Wiki ====

With entries (tokens?) for the steam platform...

{{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:#########]
}}

==== Example Zeeb ====

An example found on steam in the "[https://steamcommunity.com/sharedfiles/filedetails/?id=2905754195 Example Mod]." Contains entries for the steam platform.

{{code|
[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''

<!-- to edit this section click the edit link inline -->
{{Steam workshop tokens}}

== See Also ==
* https://bay12games.com/dwarves/modding_guide.html

[[Category:Modding]]
@@ Line 1: / Line 1: @@
-{{Quality|Fine}}
 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.
@@ Line 21: / Line 19: @@
 === Examples ===
-The info.txt is formatted like so:
+The three examples below are largely identical.
-{{code|
-[ID:my_first_mod]
-[NUMERIC_VERSION:1]
-[DISPLAYED_VERSION:1.0.0]
-[EARLIEST_COMPATIBLE_NUMERIC_VERSION:1]
-[EARLIEST_COMPATIBLE_DISPLAYED_VERSION:1.0.0]
-[AUTHOR:Your Name Here]
-[NAME:My First Mod]
-[DESCRIPTION:A cool mod I made!]
-}}
-The examples below are largely identical.
 ==== Example Bay 12 ====
-''This is the example found at [https://bay12games.com/dwarves/modding_guide.html Bay 12 Games]. Comment notation used after tokens <--''
+''This is the example found at [https://bay12games.com/dwarves/modding_guide.html Bay 12 Games].''
 {{code|
@@ Line 49: / Line 34: @@
 [NAME:Vanilla Items]
 [DESCRIPTION:These are the default Dwarf Fortress items.]
-[STEAM_TITLE:Test Descriptors]
-[STEAM_DESCRIPTION:Some test object definitions for shapes and colors.]
-[STEAM_TAG:mod] <-- as many as you want, use a separate STEAM_TAG for each one
-[STEAM_KEY_VALUE_TAG:test:stuff] <-- as many as you want, similarly
-[STEAM_METADATA:metadata test]
-[STEAM_CHANGELOG:made some changes]
 }}
 ==== Example DF Wiki ====
-With entries (tokens) for the steam platform...
+With entries (tokens?) for the steam platform...
 {{code|
@@ Line 103: / Line 82: @@
 ''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''
-<!-- to edit this section click the edit link inline on the read tab -->
+<!-- to edit this section click the edit link inline -->
-{{Info.txt tokens}}
-<!-- to edit this section click the edit link inline on the read tab -->
 {{Steam workshop tokens}}
 == See Also ==
-* Main article: [[Mod info token]]
-* [[Modding pitfalls]]
 * https://bay12games.com/dwarves/modding_guide.html
-* STEAM_METADATA: https://partner.steamgames.com/doc/api/ISteamUGC#SetItemMetadata
-* [[Modding#Basics_of_DF_modding]]
 [[Category:Modding]]