ModOptionsAPI

AKA MOAPI

Does your mod need simple, configurable options? Do you not want to edit core Minecraft files to do this? Or did the mod you just download tell you to come here? If so, you're in the right place.

Usage

Global Options

These options affect every world/ server you are on (depending on how the mod is designed) and can be overridden by local options.

Local Options (server/ world)

These options affect ONLY the world you are on, or the server. If they are set to GLOBAL they will use the value set in the global options. Otherwise, they override the global values.

If the option is not available in singleplayer, or multiplayer, the mod creator has choosen to disable it locally.

Finally, to put a value back to GLOBAL, right click it.

API Features


 * 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
 * Super simple API using a new ModOptions file format!

Version History and API Changes

Version 0.6 (GuiApi Patch) (Developer Version) - Current 1.5_01 Release

(Overview)


 * Added callbacks
 * Updated for MCP212/Minecraft Beta 1.5_01 - Added scrolling in menus

(API Additions)


 * MOCallback abstract class

(Improvements)


 * Some bug fixes, details forgotten due to 1.5 release

(File Changes)


 * GuiModOptions.java -> GuiModScrollOptions.java (not a part of the public API, part of implementation)

1.4_01 Releases (Unsupported as of 0.6)

Version 0.5.0.3 (GuiApi Patch) (Developer Version)


 * Fixed a bug in 0.5.0.3 preventing MappedMultiOptions working correctly

Version 0.5.0.2 (GuiApi Patch) (Developer Version)


 * Fixed bug in sliders preventing them from setting local mode