Config entry dependencies

[MattSturgeon]

As per #26, it'd be great if config entries could be hidden or disabled when a different config entry is in a certain state. i.e. one depends on the other.

This branch has evolved significantly since initially opening this as a Draft PR. It is becoming a fairly comprehensive dependency system, although that has lead to a few areas that are perhaps overly complex. At the very least there are edge-cases that have had little-to-no testing.

The main usage scenario (any entry depending on a boolean entry) is feature complete, barring any design changes.

Original description

I've begun working on implementing this, it's currently in early stages (hence draft PR) but I was hoping to spark discussion so I don't spend ages implementing things in a way you disagree with or make it difficult to achieve other features you have planned.

Goals:

• Disable a dependant config when a specified boolean config is in a given state
• Optionally hide the config instead of just disabling it
• Autoconfig (annotation based) implementation
  • @EnableIf and @EnableIfGroup declare a dependency that will enable/disable the annotated config entry
  • @ShowIf and @ShowIfGroup declare a dependency that will show/hide the annotated config entry
  • Declaring multiple @EnableIf or @ShowIf annotations on a single field will automatically create a group that depends on all of those dependencies.
  • Might consider renaming these... Maybe @EnabledWhen, @DisabledUnless, etc?
• Consider UI for different config types
  • Editing is disabled
  • Text is darkened
  • Sub-Category & List icons are darkened
  • Sub-Category & Lists are always collapsed/cannot be expanded
  • (Not sure what other edge-cases need to be covered?)
• Refine UI for various edge-cases (edge-cases still need to be identified)
  • I noticed some config entries don't support tooltips, such as the List entries.
• Improve generated tooltips when there are multiple dependencies, groups, multiple conditions, etc
• Refine the cloth-config dependency API using a dependency builder
• Groups of dependencies
• Boolean dependencies
• Enum dependencies
• Numeric dependencies
• Numeric comparison conditions (i.e. greater than, less than, equal, not equal)
• KeyBind dependencies?
• List dependencies?
• String/text dependencies?
• RegexCondition class for text-based dependencies?
• Separate API from implementation (as much as practical)

[MattSturgeon]

Selection/Enum entries can now be dependencies too:

selection.dependencies.mp4

Multiple condition values can be set, e.g:

entryBuilder.startBooleanToggle(Component.literal("I only work when a good option is chosen..."), true)
    .setTooltip(Component.literal("Select good or better above"))
    .addDependency(Dependency.disabledWhenNotSatisfied(enumDependency,
                                                       DependencyDemoEnum.EXCELLENT,
                                                       DependencyDemoEnum.GOOD))
    .build();

[shedaniel]

Ah, looks good after a primitive check! Thanks for implementing it!

[MattSturgeon]

Added an initial annotation implementation. I've haven't tested it yet because I couldn't figure out an easy way to run the Autoconfig demo in my debugging environment.

No compiler warnings though so fingers crossed... 🤞

EDIT: Figured out I can shift-click the button in mod-menu to open the autoconfig example.

Ah, looks good after a primitive check! Thanks for implementing it!

Thanks, looking forward to more detailed feedback when you have time 👍