Mod Detection: Difference between revisions
More actions
Bonsaibauer (talk | contribs) Create en-GB source page for translation |
Bonsaibauer (talk | contribs) Marked this version for translation |
||
| Line 15: | Line 15: | ||
<translate> | <translate> | ||
<!--T:1--> | |||
See which mod folders and files ShroudForge recognizes. Detection does not load DLLs or change mod files. | See which mod folders and files ShroudForge recognizes. Detection does not load DLLs or change mod files. | ||
== What is detected? == | == What is detected? == <!--T:2--> | ||
<!--T:3--> | |||
Installed mods are unpacked folders under <code>mods/<mod-folder>/</code> or your configured mods directory. ShroudForge reads <code>mod.json</code>, optional <code>extended.mod.json</code>, <code>src/mod.lua</code>, <code>native-plugin.ini</code> and existing DLL files. A Lua-only mod needs no DLL of its own. A native mod can appear in the DLL Manager without a manifest or Lua file. | Installed mods are unpacked folders under <code>mods/<mod-folder>/</code> or your configured mods directory. ShroudForge reads <code>mod.json</code>, optional <code>extended.mod.json</code>, <code>src/mod.lua</code>, <code>native-plugin.ini</code> and existing DLL files. A Lua-only mod needs no DLL of its own. A native mod can appear in the DLL Manager without a manifest or Lua file. | ||
<!--T:4--> | |||
This view tells you whether a folder and its information were recognized. Actual native loading appears in the DLL Manager. The mod's own page shows its overall status. | This view tells you whether a folder and its information were recognized. Actual native loading appears in the DLL Manager. The mod's own page shows its overall status. | ||
== Unknown manifest fields == | == Unknown manifest fields == <!--T:5--> | ||
<!--T:6--> | |||
With the Mod Detection module and tolerant reading enabled, <code>mod.json</code> and <code>extended.mod.json</code> may contain extra fields unknown to ShroudForge. Those fields alone do not reject a package. Known fields must still contain valid values. Invalid JSON, missing required information and incorrect data types remain errors. | With the Mod Detection module and tolerant reading enabled, <code>mod.json</code> and <code>extended.mod.json</code> may contain extra fields unknown to ShroudForge. Those fields alone do not reject a package. Known fields must still contain valid values. Invalid JSON, missing required information and incorrect data types remain errors. | ||
<!--T:7--> | |||
Disabling this compatibility option restores strict validation. It does not automatically delete or disable all installed mods. | Disabling this compatibility option restores strict validation. It does not automatically delete or disable all installed mods. | ||
== A mod is not recognized == | == A mod is not recognized == <!--T:8--> | ||
<!--T:9--> | |||
Check the actual mod folder first. A download folder may contain another wrapper folder or a <code>mods</code> directory. The installer locates a single enclosed mod package. A fresh archive containing several mod packages is not installed automatically as a group. Extract it and install one mod folder at a time. During normal operation, ShroudForge reads unpacked mod folders rather than archives. | Check the actual mod folder first. A download folder may contain another wrapper folder or a <code>mods</code> directory. The installer locates a single enclosed mod package. A fresh archive containing several mod packages is not installed automatically as a group. Extract it and install one mod folder at a time. During normal operation, ShroudForge reads unpacked mod folders rather than archives. | ||
<!--T:10--> | |||
Correct the reported JSON location or install the complete package again. A compatibility profile can supply an adapter for known differences. Recognition alone does not confirm that native hooks or mod APIs work. | Correct the reported JSON location or install the complete package again. A compatibility profile can supply an adapter for known differences. Recognition alone does not confirm that native hooks or mod APIs work. | ||
Latest revision as of 21:38, 6 November 2026
See which mod folders and files ShroudForge recognizes. Detection does not load DLLs or change mod files.
What is detected?
Installed mods are unpacked folders under mods/<mod-folder>/ or your configured mods directory. ShroudForge reads mod.json, optional extended.mod.json, src/mod.lua, native-plugin.ini and existing DLL files. A Lua-only mod needs no DLL of its own. A native mod can appear in the DLL Manager without a manifest or Lua file.
This view tells you whether a folder and its information were recognized. Actual native loading appears in the DLL Manager. The mod's own page shows its overall status.
Unknown manifest fields
With the Mod Detection module and tolerant reading enabled, mod.json and extended.mod.json may contain extra fields unknown to ShroudForge. Those fields alone do not reject a package. Known fields must still contain valid values. Invalid JSON, missing required information and incorrect data types remain errors.
Disabling this compatibility option restores strict validation. It does not automatically delete or disable all installed mods.
A mod is not recognized
Check the actual mod folder first. A download folder may contain another wrapper folder or a mods directory. The installer locates a single enclosed mod package. A fresh archive containing several mod packages is not installed automatically as a group. Extract it and install one mod folder at a time. During normal operation, ShroudForge reads unpacked mod folders rather than archives.
Correct the reported JSON location or install the complete package again. A compatibility profile can supply an adapter for known differences. Recognition alone does not confirm that native hooks or mod APIs work.