Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate the mandatory dependency field and replace it with a type field #51

Merged
merged 6 commits into from
Dec 16, 2023

Conversation

Matyrobbrt
Copy link
Member

@Matyrobbrt Matyrobbrt commented Dec 14, 2023

The mandatory field is verbatim replaced by type="required" and type="optional".
Two more options are added:

  • incompatible: prevents loading with the mod installed
  • discouraged: prompts the user a warning when the mod is installed

A reason field is also added to be able to specify what leads to the incompatibility/conflict.

Depends on neoforged/NeoForgeSPI#4

image
image

Something to consider later, when a rework of the loading code is done. The dependency graph should be able to distinguish between incompatible and normal dependencies for the sake of slightly improving the error message.

@Matyrobbrt Matyrobbrt marked this pull request as ready for review December 14, 2023 14:21
@3TUSK
Copy link

3TUSK commented Dec 15, 2023

A reason field is also added to be able to specify what leads to the incompatibility/conflict.

Can you use translation key for this field?

Copy link
Member

@Technici4n Technici4n left a comment

Choose a reason for hiding this comment

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

🚢🇮🇹

@Technici4n Technici4n merged commit 4b8ac82 into neoforged:main Dec 16, 2023
1 check passed
@Matyrobbrt Matyrobbrt deleted the breaks-clause branch December 16, 2023 20:17
@Matyrobbrt
Copy link
Member Author

A reason field is also added to be able to specify what leads to the incompatibility/conflict.

Can you use translation key for this field?

Unfortunately not @3TUSK, the error happens way too early for resources (and inherently mod lang files) to be loaded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants