Dependencies: Difference between revisions
More actions
Bonsaibauer (talk | contribs) Created page with "<!-- ShroudForge MediaWiki migration metadata title: Dependencies description: Find required components and known conflicts between mods. This view explains what blocks an active mod and which dependency needs attention. language: en creator: Bonsaibauer source: modules/wiki/articles/dependencies/en.md --> Find required components and known conflicts between mods. This view explains what blocks an active mod and which dependency needs attention. File:ShroudForge-Wiki..." |
No edit summary |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- ShroudForge | <languages /> | ||
<!-- ShroudForge Modloader Wiki Post | |||
title: Dependencies | title: Dependencies | ||
description: Find required components and known conflicts between mods. This view explains what blocks an active mod and which dependency needs attention. | description: Find required components and known conflicts between mods. This view explains what blocks an active mod and which dependency needs attention. | ||
language: en | language: en-GB | ||
picture:ShroudForge-Wiki-dependencies.svg | |||
creator: Bonsaibauer | creator: Bonsaibauer | ||
--> | --> | ||
[[File:ShroudForge-Wiki-dependencies.svg|thumb|left|600px|Dependencies]] | |||
<br style="clear:both;" /> | |||
<translate> | |||
<!--T:1--> | |||
Find required components and known conflicts between mods. This view explains what blocks an active mod and which dependency needs attention. | Find required components and known conflicts between mods. This view explains what blocks an active mod and which dependency needs attention. | ||
== Required mods == <!--T:2--> | |||
== Required mods == | |||
<!--T:3--> | |||
A mod can declare other mods and their required versions in <code>mod.json</code>. ShroudForge checks whether they are installed, enabled and suitable for the current client or server. A missing or disabled required dependency prevents the affected mod from starting. An incompatible version also blocks it. | A mod can declare other mods and their required versions in <code>mod.json</code>. ShroudForge checks whether they are installed, enabled and suitable for the current client or server. A missing or disabled required dependency prevents the affected mod from starting. An incompatible version also blocks it. | ||
<!--T:4--> | |||
Open the named mod, install or enable its requirement, then check this view again. Not every installed mod needs to run in the current process. A client-only mod does not need its own startup on a server. | Open the named mod, install or enable its requirement, then check this view again. Not every installed mod needs to run in the current process. A client-only mod does not need its own startup on a server. | ||
== Optional dependencies == | == Optional dependencies == <!--T:5--> | ||
<!--T:6--> | |||
An explicitly optional dependency may be absent or disabled. An extra feature may then be unavailable. If the dependency is present and enabled, its version and further requirements still need to match. | An explicitly optional dependency may be absent or disabled. An extra feature may then be unavailable. If the dependency is present and enabled, its version and further requirements still need to match. | ||
<!--T:7--> | |||
Mods without declared dependencies need no separate problem entry here. Their overall status remains available on their own mod pages. | Mods without declared dependencies need no separate problem entry here. Their overall status remains available on their own mod pages. | ||
== Conflicts and cycles == | == Conflicts and cycles == <!--T:8--> | ||
<!--T:9--> | |||
Known conflict rules identify two active mods that should not run together in the specified combination. Use the message to decide which one to disable. A dependency cycle means mods require each other to start first. This needs a package correction or a change by the author. | Known conflict rules identify two active mods that should not run together in the specified combination. Use the message to decide which one to disable. A dependency cycle means mods require each other to start first. This needs a package correction or a change by the author. | ||
<!--T:10--> | |||
A requirement for <code>shroudforge-api</code> refers to the loader's mod API. It is separate from automatic DLL compatibility-profile matching. | A requirement for <code>shroudforge-api</code> refers to the loader's mod API. It is separate from automatic DLL compatibility-profile matching. | ||
[[Category:guide: | </translate> | ||
[[Category:guide:Shroudforge]] | |||
Latest revision as of 17:47, 5 November 2026
Find required components and known conflicts between mods. This view explains what blocks an active mod and which dependency needs attention.
Required mods
edit edit sourceA mod can declare other mods and their required versions in mod.json. ShroudForge checks whether they are installed, enabled and suitable for the current client or server. A missing or disabled required dependency prevents the affected mod from starting. An incompatible version also blocks it.
Open the named mod, install or enable its requirement, then check this view again. Not every installed mod needs to run in the current process. A client-only mod does not need its own startup on a server.
Optional dependencies
edit edit sourceAn explicitly optional dependency may be absent or disabled. An extra feature may then be unavailable. If the dependency is present and enabled, its version and further requirements still need to match.
Mods without declared dependencies need no separate problem entry here. Their overall status remains available on their own mod pages.
Conflicts and cycles
edit edit sourceKnown conflict rules identify two active mods that should not run together in the specified combination. Use the message to decide which one to disable. A dependency cycle means mods require each other to start first. This needs a package correction or a change by the author.
A requirement for shroudforge-api refers to the loader's mod API. It is separate from automatic DLL compatibility-profile matching.