Modding pitfalls - Revision history

DPhKraken: /* My mod won't update */ Non-portable storage pitfall

2025-07-22T21:30:09Z

My mod won't update: Non-portable storage pitfall

Tekkud: /* Reactions */

2025-03-22T19:20:14Z

Reactions

Silverwing235 at 21:10, 10 January 2025

2025-01-10T21:10:45Z

Silverwing235 at 21:10, 10 January 2025

2025-01-10T21:10:02Z

DPhKraken: New update section. Token/code formatting

2025-01-10T19:59:26Z

New update section. Token/code formatting

DPhKraken: /* My mod won't load*/ Formatting.

2025-01-10T19:46:49Z

My mod won't load: Formatting.

Alpacalypse: /* Reactions */ Added entity token pitfall

2023-03-05T09:34:17Z

Reactions: Added entity token pitfall

Alpacalypse: /* Creatures */ Added common pitfall with creature edits

2023-03-05T09:28:03Z

Creatures: Added common pitfall with creature edits

Alpacalypse: /* My mod loads, but my creature/plant/entity won't */ SPAG

2023-03-05T09:15:23Z

My mod loads, but my creature/plant/entity won't: SPAG

Alpacalypse: /* My mod loads, but my creature/plant/entity won't */ (somewhat subjective) clarification in wording

2023-02-11T23:56:04Z

My mod loads, but my creature/plant/entity won't: (somewhat subjective) clarification in wording

@@ Line 43: / Line 43: @@
 ''Dwarf Fortress'' only reads from ``installed_mods`` (``Dwarf Fortress/data/installed_mods``) when loading a world. If you have made changes to your mod since installing it, you will need to propagate your edits from ``mods`` to ``installed_mods`` to see them in-game. For quick testing, the easiest way to do so is by deleting the old copy in ``installed_mods``. You can also increase {{token|NUMERIC_VERSION|modinfo}} and {{token|EARLIEST_COMPATIBLE_NUMERIC_VERSION|modinfo}} to create a new copy.
-Although you can edit currently-installed mods directly from the ``installed_mods`` folder , this often leads to confusion over where/how errors or bugs are occurring, as well as increasing the risk of accidentally overwriting edits made there. Applying newly-edited raws by working from the ``mods`` folder and loading them in from the in-game menu can avoid many oversights in troubleshooting.
+As of 52.01, the game defaults to non-portable storage. Even if working out of the portable copy of ``mods``, this setting copies installed mods into the game's AppData [[File|folder]].
 == My mod causes glitches in world generation/won't work with '(other mod)' ==

← Older revision		Revision as of 19:20, 22 March 2025
Line 67:		Line 67:

	Currently, only the internal make armor/clothing tasks can set the product size via the Details screen; custom reactions cannot do this. If you want to be able to size things when ordering them to be made, they have to be included in the entity using the [[Entity_token#Available_resources\|ARMOR]] token. The size selection menu only displays if armor/clothing made from cloth, leather, or weapons-grade metal is being produced.		Currently, only the internal make armor/clothing tasks can set the product size via the Details screen; custom reactions cannot do this. If you want to be able to size things when ordering them to be made, they have to be included in the entity using the [[Entity_token#Available_resources\|ARMOR]] token. The size selection menu only displays if armor/clothing made from cloth, leather, or weapons-grade metal is being produced.
		+
		+	=== Workers are not using items from barrels even though they're using them otherwise ===
		+
		+	When defining reagents, not including an item type (e.g. PLANT:NONE, PLANT_GROWTH:NONE) will cause workers to be unable to find otherwise eligible reagents when they're stored in barrels.

	[[Category: Modding]]		[[Category: Modding]]

@@ Line 11: / Line 11: @@
 Make sure you have an [[info.txt file]] and that your mod is in the root directory of the ``mods`` folder (``Dwarf Fortress/mods``), '''not''' in the ``mod_upload`` folder. ''Dwarf Fortress'' doesn't read ``mod_upload`` for using mods, but only to [[Mod#Publishing mods|publish]] them to the Steam Workshop.
-Make sure you have '''every [[Mod info token#Tokens|required token in your info.txt!]]'''  Also, make sure that the mod has a {{token|NUMERIC_VERSION|modinfo}} which is an integer, and greater than or equal to {{token|EARLIEST_COMPATIBLE_NUMERIC_VERSION|modinfo}}. So this is acceptable:
+Make sure you have '''every [[Mod info token#Tokens|required token in your info.txt!]]'''  Also, make sure that the mod has a {{token|NUMERIC_VERSION|modinfo}} which is an integer, and greater than or equal to {{token|EARLIEST_COMPATIBLE_NUMERIC_VERSION|modinfo}}.
 {{code|

@@ Line 9: / Line 9: @@
 == My mod won't load ==
-Make sure you have an [[info.txt file]] and that your mod is in the root directory of the ``mods`` folder (``Dwarf Fortress/mods``), '''not''' in the ``mod_upload`` folder. Dwarf Fortress doesn't read ``mod_upload`` for using mods, but only to [[Mod#Publishing mods|publish]] them to the Steam Workshop.
+Make sure you have an [[info.txt file]] and that your mod is in the root directory of the ``mods`` folder (``Dwarf Fortress/mods``), '''not''' in the ``mod_upload`` folder. ''Dwarf Fortress'' doesn't read ``mod_upload`` for using mods, but only to [[Mod#Publishing mods|publish]] them to the Steam Workshop.
-Make sure you have '''every [[Mod info token#Tokens|required token in your info.txt!]]'''
+Make sure you have '''every [[Mod info token#Tokens|required token in your info.txt!]]'''  Also, make sure that the mod has a {{token|NUMERIC_VERSION|modinfo}} which is an integer, and greater than or equal to {{token|EARLIEST_COMPATIBLE_NUMERIC_VERSION|modinfo}}. So this is acceptable:
 {{code|
@@ Line 41: / Line 39: @@
 == My mod won't update ==
-Dwarf Fortress only reads from ``installed_mods`` (``Dwarf Fortress/data/installed_mods``) when loading a world. If you have made changes to your mod since installing it, you will need to propagate your edits from ``mods`` to ``installed_mods`` to see them in-game. For quick testing, the easiest way to do so is by deleting the old copy in ``installed_mods``. You can also increase {{token|NUMERIC_VERSION|modinfo}} and {{token|EARLIEST_COMPATIBLE_NUMERIC_VERSION|modinfo}} to create a new copy.
+''Dwarf Fortress'' only reads from ``installed_mods`` (``Dwarf Fortress/data/installed_mods``) when loading a world. If you have made changes to your mod since installing it, you will need to propagate your edits from ``mods`` to ``installed_mods`` to see them in-game. For quick testing, the easiest way to do so is by deleting the old copy in ``installed_mods``. You can also increase {{token|NUMERIC_VERSION|modinfo}} and {{token|EARLIEST_COMPATIBLE_NUMERIC_VERSION|modinfo}} to create a new copy.
-Although you can edit currently-installed mods directly from the ``installed_mods`` folder , this often leads to confusion over where/how errors or bugs are occurring, as well as increasing the risk of accidentally overwriting edits made there. Applying newly edited raws by working from the ``mods`` folder and loading them in from the in-game menu can avoid many oversights in troubleshooting.
+Although you can edit currently-installed mods directly from the ``installed_mods`` folder , this often leads to confusion over where/how errors or bugs are occurring, as well as increasing the risk of accidentally overwriting edits made there. Applying newly-edited raws by working from the ``mods`` folder and loading them in from the in-game menu can avoid many oversights in troubleshooting.
 == My mod causes glitches in world generation/won't work with '(other mod)' ==
@@ Line 64: / Line 62: @@
 Make sure you have added the corresponding tokens to the relevant civilization entity object ({{token|PERMITTED_BUILDING|e}}/{{token|PERMITTED_REACTION|e}}).
-=== My custom armor/clothing reaction won't let user choose size ===
+=== My custom armor/clothing reaction won't let the user choose the size ===
-Currently only the internal make armor/clothing tasks can set the product size via the Details screen; custom reactions cannot do this. If you want to be able to size things when ordering them to be made, they have to be included in the entity using the [[Entity_token#Available_resources|ARMOR]] token. The size selection menu only displays if armor/clothing made from cloth, leather, or weapons-grade metal is being produced.
+Currently, only the internal make armor/clothing tasks can set the product size via the Details screen; custom reactions cannot do this. If you want to be able to size things when ordering them to be made, they have to be included in the entity using the [[Entity_token#Available_resources|ARMOR]] token. The size selection menu only displays if armor/clothing made from cloth, leather, or weapons-grade metal is being produced.
 [[Category: Modding]]

@@ Line 6: / Line 6: @@
 == Errorlog ==
-The errorlog is in a file called "errorlog.txt", located in the root directory of the game (the same folder as Dwarf Fortress's executable). Check that before you read on; your problem may in fact be in there.
+The error log is in a file called ``errorlog.txt``, located in the root directory of the game (the same folder as Dwarf Fortress's executable). Check that before you read on; your problem may in fact be in there.
 == My mod won't load ==
@@ Line 33: / Line 33: @@
 Make sure the file has the correct name, and starts with the following lines:
-# A filename that refers to the type of objects contained therein. '''Creature files must start with creature_, entity files must start with entity_, and so on.'''
+# A filename that refers to the type of objects contained therein. '''Creature files must start with ``creature_``, entity files must start with ``entity_``, and so on.'''
 # The filename on the first line of the file.
-# [OBJECT:type], where "type" is replaced with the relevant object type, [OBJECT:CREATURE] etc
+# ``[OBJECT:type]``, where "type" is replaced with the relevant object type, ``[OBJECT:CREATURE]`` etc
 If your edit meets all of the above criteria, and still won't load, you can ask, or look for, specific advice from these [[Modding#Resource Overview|modding resources]].
-Although you can edit currently installed mods directly from the ''installed_mods'' folder (''Dwarf Fortress\data\installed_mods''), this often leads to confusion over where/how errors or bugs are occurring, as well as increasing the risk of accidentally overwriting edits made there. Applying newly edited raws by adding them to the 'mods' folder and loading them in from the in-game menu can avoid many oversights in troubleshooting.
+== My mod won't update ==
 == My mod causes glitches in world generation/won't work with '(other mod)' ==
@@ Line 49: / Line 53: @@
 === My civilization lives in "Nothing hamlets", "Nothing fortresses" or similar ===
-You forgot to add a [[Creature_token#N|NAME]]. These use NAME rather than CASTE_NAME, so if you have a CASTE_NAME but no NAME, you'll see the individuals having a correct species name but their sites not having one.
+You forgot to add a {{token|NAME}}. These use {{token|NAME}} rather than {{token|CASTE_NAME}}, so if you have a {{token|CASTE_NAME}} but no {{token|NAME}}, you'll see the individuals having a correct species name but their sites not having one.
 === Creature edits not working or duplicate creatures/creature materials appearing in-game ===
@@ Line 58: / Line 62: @@
 === My custom reaction isn't appearing in the game ===
-Make sure you have added the corresponding tokens to the relevant civilization entity object [[Entity_token#Flavor|(PERMITTED_BUILDING/JOB/REACTION)]].
+Make sure you have added the corresponding tokens to the relevant civilization entity object ({{token|PERMITTED_BUILDING|e}}/{{token|PERMITTED_REACTION|e}}).
 === My custom armor/clothing reaction won't let user choose size ===

← Older revision		Revision as of 09:34, 5 March 2023
Line 55:		Line 55:

	== Reactions ==		== Reactions ==
		+
		+	=== My custom reaction isn't appearing in the game ===
		+
		+	Make sure you have added the corresponding tokens to the relevant civilization entity object [[Entity_token#Flavor\|(PERMITTED_BUILDING/JOB/REACTION)]].

	=== My custom armor/clothing reaction won't let user choose size ===		=== My custom armor/clothing reaction won't let user choose size ===

@@ Line 37: / Line 37: @@
 # [OBJECT:type], where "type" is replaced with the relevant object type, [OBJECT:CREATURE] etc
-If it does have all those, ask in one of the [[Modding#Resource Overview|many places there are where one may get help.]]
+If your edit meets all of the above criteria, and still won't load, you can ask, or look for, specific advice from these [[Modding#Resource Overview|modding resources]].
 Although you can edit currently installed mods directly from the ''installed_mods'' folder (''Dwarf Fortress\data\installed_mods''), this often leads to confusion over where/how errors or bugs are occurring, as well as increase the risk of accidentally overwriting edits made there. Applying newly edited raws by adding them to the 'mods' folder and loading them in from the in-game menu can avoid many oversights in troubleshooting.