MiliUI helps you build menus, Buttons, text, and other game screens in Miliastra Wonderland using Lua. You write what you want the interface to show, and MiliUI creates the controls and helps them work together. It also provides tools for scrolling, controller support, screen sizes, and more.
Public Beta: v0.9.0-beta.5
MiliUI is available for real Miliastra creator testing. This repository is the public home for releases, documentation, examples, and issue tracking. The framework's development source remains private.
Making your first MiliUI screen? Follow these three steps in order:
- Set up MiliUI: Installation + Setup shows how to install it. If you are starting a new game, the ready-made starter save can skip most of the setup.
- Make your first menu: Quick Start walks through one small screen and explains the code as you add it.
- Try another example: Getting Started Examples has small scripts you can copy and change.
You do not need to know Lua already. Words like Host and Page are explained in the Documentation Index.
Already using MiliUI? Read the beta.5 upgrade guide. For a specific Button, setting, or function, try API at a glance, Components, or the complete API reference.
Using an older beta? Follow the upgrade guides in order: beta.2, beta.3, beta.4, then beta.5.
Public beta runtime downloads are published under GitHub Releases.
The recommended installation path is MiliUI Manager, which installs the production runtime into one selected Miliastra project and creates a backup before replacing an existing installation.
For a new project, the release also includes MiliUI-Template-Save-File.gil, a ready-to-use starter save with the one-time MiliUI setup and Quick Start example already configured. See Installation + Setup before entering Test Play.
For VS Code editor support, the public beta.5 GitHub Release includes MiliUI IntelliSense v0.1.16. Install the VSIX using Extensions → ... → Install from VSIX.... The Visual Studio Marketplace also lists MiliUI IntelliSense; its version may differ. See the IntelliSense setup and troubleshooting guide.
Advanced users can also download the production MiliUI-init.lua runtime directly.
This repository contains:
- public documentation;
- beginner and reference examples;
- release notes and version history;
- public issue templates;
- downloadable release artifacts.
The readable MiliUI framework source is not distributed from this repository.
The Miliastra creator Discord is the primary place for questions, feedback, and discussion. Confirmed framework bugs can be tracked here as GitHub Issues.
Before reporting a bug, see Support and Bug Reports. Common project/licensing questions are covered in the FAQ.
MiliUI is not an open-source framework. Use of the MiliUI runtime is governed by the MiliUI License.
In short: you may use official MiliUI releases in your Miliastra projects, but you may not redistribute, republish, fork, repackage, or present MiliUI itself as your own framework. See the license for the complete terms.
The current public beta is v0.9.0-beta.5. APIs are intended to be usable in real projects, but changes may still occur before 1.0 as creator feedback reveals problems. See Known Issues for current framework and Miliastra-platform limitations that may affect projects.