Mods/ModOptionsAPI

From Minecraft Wiki
The contents of this page are not supported by Mojang AB, the Minecraft Wiki, or the Minecraft Forum.

Lua error in package.lua at line 80: module 'Module:Navbar/configuration' not found.

File:ModoptionsAPI Options.png
The Mod Options API menu button
It has been suggested that this page be moved to ftb:ModOptionsAPI. Do not move the page until a consensus is reached. Discuss
Reason: exportation project
This page should be exported to the above page, not moved via copying and pasting the page's contents. This action must be done by an administrator on the other wiki.

This mod allows other mod developers to add simple configurable options to their mod without editing core Minecraft files. The mod adds a 'Mod Options' button in the Minecraft menu containing settings for any supported mods. Mods that use this feature include Minecraft Enhanced and Nature Overhaul amongst others.

The mod also allows developers the option to change settings for every world/ server other mods are run on, or to only affect the single currently loaded world.

Options available to developers[edit | edit source]

API Features[edit | edit source]

  • Boolean/Toggle options
  • List/MultiValue options
  • Slider options (int/float based)
  • Sub-option menus for more complex menus
  • A more complex OO API for those who dislike the simpler addToggleOption/getOptionValue/setOptionValue API
  • Full included JavaDoc, source and a fully working example mod in the download
  • Simple API for modifying the GUI settings
  • Well designed and consistent API
  • World and server specific values