English

Lumina UI is a library for beautiful, fast and flexible interfaces in Minecraft mods. Forge 1.20.1 and NeoForge 1.21.1, one API for both versions.

🇷🇺 Русская версия: Главная

Where to start

1. Installation: add the library to your mod (5 minutes).
2. Your First Screen: open your first screen.
3. Widget Catalog: see what is ready to use.

The live showcase of every feature is the luminatest test mod: press K in a world or run /luminatest.

I want to…

Task	Page
Make a settings screen for my mod	[[Config Screen
Make my own chest or machine with a screen	[[Container Screens
Show bars and notifications on top of the game	[[HUD Overlay
Build a screen in HTML and CSS	[[HTML and CSS
Restyle the UI to match my mod	[[Styles and Themes
Smoothly animate a button or panel	Animations
Show a mob, item or structure in 3D	[[Mobs, Items and 3D
Translate the UI into other languages	Languages
Write my own widget	Extending

Prefer one long page? The whole guide is also on Developer Guide.

All topics

Getting started

• Installation — how to add Lumina UI to your mod on Forge 1.20.1 or NeoForge 1.21.1.
• Your First Screen — build your first screen and learn what a UI is made of.

Basics

• Layout — how to place elements: flexbox, layers, grid, sizes, responsiveness.
• Styles and Themes — widget styles, states, themes and tokens.
• Colors and Gradients — colors in different color spaces, gradients and brushes.
• Animations — property animations, keyframes, timelines, easing curves and springs.
• Data and Signals — how to bind data to the UI so it updates by itself.
• Events and Input — mouse, keyboard, focus and gamepad.

Widgets

• Widget Catalog — all widgets by group and the most used components.
• Popups — dropdowns, tooltips, context and radial menus, calendar.
• Forms — input validation, forms and setup wizards.
• Markdown and Books — multi-line Markdown text, books and syntax highlighting.

Game

• Inventory and Slots — stacks, slots, grids and item drag and drop.
• Container Screens — your own chests and machines with a Lumina screen, synced by the server.
• Mobs, Items and 3D — entities, items and structures in 3D, block maps and world preview.
• HUD Overlay — uI on top of the game and live player data.
• Maps — minimap and world map.

Visuals

• Effects — fire, explosions, TNT, weather and particles right in the UI.
• Blur, Clipping and GIF — backdrop blur, exact rounded clipping and animated images.

HTML and CSS

• HTML and CSS — screens from markup and styles: quick start, tags and CSS.

Features

• Languages — live language switching and translations.
• Config Screen — a ready settings screen from a simple description.
• Accessibility and Sounds — color blindness, high contrast, text scale and UI sounds.

Advanced

• Extending — your own widgets, properties, events, layouts and tags.
• Debugging and Tips — uI inspector, performance and common mistakes.
• Architecture — how Lumina UI works inside.

License

GNU LGPL 3.0: you can use the library in any mod, including closed-source ones. Source: github.com/ssbaxys/lumina-ui.