Xi's Multiversion UI Lib docs

Build mod menus once with plain Java widgets and run them on Minecraft 1.7.10 to 26.3 across every major loader.

Last updated

Xi's Multiversion UI Lib lets a mod describe its screens with plain Java widgets (MenuScreen, Button, Toggle, Cycle, TextInput, SelectList and more) and register the first one. At runtime the library picks the backend for the running game and draws the widgets with that version's own GUI classes. Your mod compiles against one small API jar with no Minecraft classes in it.

Getting started#

  1. Compile against the API jar (compileOnly). Don't bundle it: the library's mod jar provides it at runtime.
  2. Declare a dependency on the xis_mvui mod id in your loader's mod metadata.
  3. Register your menu once, on the client, while the game starts.

Guides for each step will be added here as the 0.x API settles.

API reference

Javadoc coming soon.