Skip to main content

Plugin Settings Definition

Plugins declare settings through GetSettingsDefinitions(). Host renders UI, persists values, and returns them via settingsValues in plugin calls.

Design principles​

  • Keep keys stable after release
  • Describe purpose/default/risk clearly
  • Use safe fallback values when parsing fails

Practical recommendations​

  • Parse boolean values robustly, accepting true, false, 1, and 0
  • Add min/max boundary checks for numeric settings
  • Validate path accessibility for path settings

Example​

MineRewind uses two boolean settings:

  • EnableHotBackup
  • PreservePlayerData