minuit UI components for Minecraft mods.

Let your players pick their theme.

Get started View components

Settings panel with toggles, a slider and a dropdown

Confirm dialog with a destructive Delete button

Toggle groups for view mode and sort order

Online players with skin heads and status dropdowns

Every card runs minuit itself (the same as in Minecraft).

Depend on it

Add minuit as a required dependency. The API stays the same through 1.x.

NeoForge

neoforge.mods.toml

[[dependencies.mymod]]
modId = "minuit"
type = "required"
versionRange = "[1.0,2.0)"
side = "CLIENT"

Fabric

fabric.mod.json

"depends": {
  "minuit": ">=1.0.0 <2.0.0"
}

A screen is a PanelComponent subclass. It holds no Minecraft class, so a test can draw it into an image without starting the game. In game, a MinuitScreen hosts it, and Themes.byId("mymod") returns the look the player chose for your mod.

SettingsPanel.java

public class SettingsPanel extends PanelComponent {
    public SettingsPanel(Theme theme, Words words, int left, int top) {
        super(theme, words, left, top);
        add(new ToggleComponent(at(new Box("coords", 10, 10, 160, 12)), "Show coordinates", true, on -> { }));
        add(new SliderComponent(at(new Box("render", 10, 28, 160, 12)), 2, 32, 12, v -> { }));
        add(new ButtonComponent(at(new Box("done", 10, 50, 80, 16)), "Done", this::done)
                .role(ButtonComponent.Role.PRIMARY));
    }

    @Override public int width() { return 180; }
    @Override public int height() { return 76; }
}

Components

The Java to copy, in every theme.

ButtonComponent

Displays a button.

ToggleComponent

Switches one setting on or off.

SliderComponent

Picks a whole number in a range.

DropdownComponent

Opens a list of choices.

TextFieldComponent

A single line of text to edit.

TabsComponent

Switches between parts of a screen.

ToggleGroupComponent

A row of buttons where one or several can be on.

ListComponent

A scrolling list of rows you draw yourself.

ProgressComponent

Shows how far a task has got.

MeterComponent and WaveComponent

Shows a sound level in decibels.

SpinnerComponent

Shows that something is loading.

PanelComponent

The surface of a screen.

ScrollComponent

Scrolls components that do not fit their box.

GridComponent

Cards in rows of a fixed number of columns.

SectionComponent

A titled block the player can fold.

WindowComponent

A panel in a window the player can move and scale.

RadialComponent

A wheel of choices around the cursor.

ReelComponent

A roulette that lands on one card.

ColorPickerComponent

Picks a colour.

ItemPickerComponent

Lets the player pick any item in the game.

SlotGridComponent and PlayerInventoryComponent

The game's item slots, drawn in your theme.

ToastSpec

Shows a toast in the game's own stack, in the player's theme.

RichTextComponent

Prints text with the game's colour and style codes, written with the section sign or &.

EntityPreviewComponent

Shows an entity or a block in 3D.

KeybindFieldComponent

Rebinds one key or mouse button.

Use with an AI assistant

Prompt

Read https://minuit.dryaides.com/llms-full.txt and build my mod's screens with the minuit library (PanelComponent, MinuitScreen).

The short index is at llms.txt; each component page also exists as Markdown.