Skip to content

Repository files navigation

DearOreUI Designer

Design and preview Minecraft Bedrock OreUI — without launching the game.

An offline visual designer (Tauri 2) for mods built on the DearOreUI runtime.

Downloads · Core runtime · Documentation · Example mod · 简体中文

latest release downloads CC0-1.0 license

runtime

What is it?

DearOreUI Designer lets mod authors see their UI without running Minecraft. Point it at a mod's source tree, and it statically scans the code to recover the OreUI pages the mod declares — no mod-side changes required — then renders them on an in-app canvas that approximates the OreUI (Coherent Gameface) layout engine.

Target users Authors of DearOreUI client mods
Position Offline preview & debugging companion to the DearOreUI runtime
Workflow Open mod directory → auto-detect pages → click to preview → refresh on save

Core capabilities

  • Mod UI auto-detection (source scan). Reads registerComponent calls from C++ source, recovering DomNode bodies and ComponentSpec trees. The mod needs no modification.
  • Offline preview. Render detected UI on a canvas without a game client; a Yoga-based layout pass mimics the OreUI box model.
  • Dual-loading model. Preview both standalone mod entries and the "vanilla screen + mod overlay" combination.
  • Sidebar tabs. Only pages the mod actually changes/declares are shown; untouched screens stay hidden.
  • Vanilla resource import (planned). Import data/gui/dist/hbui assets for pixel-accurate 9-slice textures.

Install

Download the latest installer from Releases, install, and launch.

Usage

  1. Launch the desktop app.
  2. Project → Open mod directory, select a mod source tree (e.g. dearoreui-ExampleMod).
  3. Auto-detected pages appear as sidebar tabs; click one to preview on the canvas.
  4. Project → Import vanilla resources to load original UI assets for closer-to-device rendering (planned).

Tech stack

Layer Technology
Desktop host Tauri 2
UI Vite + TypeScript
Rendering Yoga layout pass approximating OreUI (Coherent Gameface); reuses the runtime's stage7 scripts and {t,s,x,a,c} node format
Scanner src-tauri/src/mod_scanner.rs — static, read-only C++ source analysis

Development

npm install        # install dependencies
npm run tauri dev  # start the desktop app in dev mode

The Rust scanner lives in src-tauri/src/; the rendering frontend in src/. Build releases with npm run tauri build (see .github/workflows/release.yml).

Ecosystem

This is one part of the DearOreUI toolchain:

Project Repository Role
DearOreUI copper-lamp/Dear-OreUI Native LeviLamina runtime — extends OreUI at runtime
DearOreUI Designer copper-lamp/DearOreUI-dev-tools This repo — offline visual preview
DearOreUI Docs copper-lamp/dearoreui-docs Official documentation & learning site
dearoreui-ExampleMod magicobs0z/dearoreui-ExampleMod Progressive tutorial mod
dearoreui-repo copper-lamp/dearoreui-repo Self-hosted xmake package repo

License

CC0-1.0, matching the DearOreUI runtime.

About

DearOreUI 的离线可视化 UI 设计器(Tauri 2)。面向 LeviLamina 模组开发者,无需启动游戏即可自动识别、预览和调试模组 UI

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages