Skip to content

Commit

Permalink
The dependency types are actually case-sensitive.
Browse files Browse the repository at this point in the history
  • Loading branch information
shartte committed Dec 24, 2023
1 parent eb25c17 commit dace1d0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/gettingstarted/modfiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Mods can specify their dependencies, which are checked by NeoForge before loadin
| Property | Type | Default | Description | Example |
|:---------------|:------:|:-------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------|
| `modId` | string | **mandatory** | The identifier of the mod added as a dependency. | `modId="jei"` |
| `type` | string | `"required"` | Specifies the nature of this dependency: `"required"` is the default and prevents the mod from loading if this dependency is missing; `"optional"` will not prevent the mod from loading if the dependency is missing, but still validates that the dependency is compatible; `"incompatible"` prevents the mod from loading if this dependency is present; `"discouraged"` still allows the mod to load if the dependency is present, but presents a warning to the user. | `type="incompatible"` |
| `type` | string | `"REQUIRED"` | Specifies the nature of this dependency: `"REQUIRED"` is the default and prevents the mod from loading if this dependency is missing; `"OPTIONAL"` will not prevent the mod from loading if the dependency is missing, but still validates that the dependency is compatible; `"INCOMPATIBLE"` prevents the mod from loading if this dependency is present; `"DISCOURAGED"` still allows the mod to load if the dependency is present, but presents a warning to the user. | `type="INCOMPATIBLE"` |
| `reason` | string | *nothing* | An optional user-facing message to describe why this dependency is required, or why it is incompatible. |
| `versionRange` | string | `""` | The acceptable version range of the language loader, expressed as a [Maven Version Range][mvr]. An empty string matches any version. | `versionRange="[1, 2)"` |
| `ordering` | string | `"NONE"` | Defines if the mod must load before (`"BEFORE"`) or after (`"AFTER"`) this dependency. If the ordering does not matter, return `"NONE"` | `ordering="AFTER"` |
Expand Down

1 comment on commit dace1d0

@neoforged-pages-deployments
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploying with Cloudflare Pages

Name Result
Last commit: dace1d0027e472c1d9975792e67a8e46671b9378
Status: ✅ Deploy successful!
Preview URL: https://bf007f32.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-40.neoforged-docs-previews.pages.dev

Please sign in to comment.