QuiltMC / quilt-config

Quilt Config (aka "haven king's metadata of madness") is a library designed to facilitate the creation and management of config files.
Apache License 2.0
21 stars 8 forks source link

Add metadata to indicate a warning should be displayed before a change is applied #31

Closed anonymous123-code closed 5 months ago

anonymous123-code commented 7 months ago

A common concern with automatic config menus is that users might expect values to be applied directly after saving. This metadata should allow to automatically display warnings if a changed option is saved. In order to help users, some common cases are already defined as an enum.

Note that if no screen-only related metadata is present for a mod, it might be safer to assume that the config requires a restart to apply. I'm not sure if this should be done on quilt-configs side

Applicable to config, section, and option.

Parameters:

ChangeWarning options:

ix0rai commented 7 months ago

love love love this idea

ix0rai commented 7 months ago

Note that if no screen-only related metadata is present for a mod, it might be safer to assume that the config requires a restart to apply. I'm not sure if this should be done on quilt-configs side

this should be done on the side of the config screen generator, and should be easy with the new API method I added for getting all metadata

OroArmor commented 6 months ago

love love love this idea

I also love love love this idea.