-
-
Notifications
You must be signed in to change notification settings - Fork 201
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deprecate the mandatory field and add an incompatible/discouraged cla…
…use to mod dependency (#386) The `mandatory` field is now deprecated, and use of it will **crash** in a development environment. The field has been replaced with a `type` field, accepting a string with one of 4 possible values (case insensitive): - `required`: - default, will not allow the game to load _without_ the dependency - `optional`: will _allow_ the game to load without the dependency - `incompatible`: will _prevent_ the game from loading when the dependency is present - `discouraged`: will _show a warning_ when the dependency is present, but will continue loading For `incompatible` and `discouraged` a `reason` string field has been added that will be shown to users. Please use this field and provide descriptive reasons as to why your mod is incompatible with the other. Example: ```toml [[dependencies.mymod]] type="discouraged" # can be "incompatible" modId="othermod" versionRange="[1.4.3,)" # optional, will match any version by default reason="We conflict because the other mod does...." ```
- Loading branch information
1 parent
f2ecd67
commit 8786a13
Showing
3 changed files
with
24 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters