Uploaded image for project: 'Minecraft API'
  1. Minecraft API
  2. MCAPI-103

Plugin settings API

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Open
    • Priority: Normal
    • Resolution: Unresolved
    • Labels:

      Description

      Proposed Addition:
      Add support for plugin specific settings with API being part of that.

      Specific Features:
      Each plugin should be able to create an array of in-game settings to be changed by user. Following methods should be able to fit most if not all possibe requirements:
      addSettingButton(string SettingName, string Tooltip, Value, string ListOfValues) - addressed value stores chosen setting as string
      addSettingSlider(string SettingName, string Tooltip, Value, float Min, float Max, float Increment) - addressed value stores a number
      addSettingBinding(string SettingName, string Tooltip, Value, DefaultButton) - addressed value stores the key assigned

      Justification and Use Case:
      Many plugins will have settings which user should be able to control. There needs to be a system designed specifically for this cause.
      Exampe use for generic minimap mod:
      addSettingButton("Size", "Size of minimap on screen", Size, "Small|Medium|Big")
      addSetingSlider("Opacity, "Opacity of minimap", Opac, 0, 100, 5)
      addSettingBinding("Show minimap", "Button to toggle visibility of minimap", Show, "M")

      Challenges Faced:
      None I can see.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              trinistr Alex Bulantsov
            • Votes:
              8 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: