Skip to content

Repository files navigation

HoloUI Editor

Visual web editor for HoloUI menu configurations. Build holographic menus on a calibrated canvas, edit every field the plugin actually parses, and export menus/<id>.json files (plus an images.zip) that drop straight into plugins/holoui/.

Version 3.1.0 — a from-scratch rewrite in arcane_jaspr (Dart, compiled to a fully static site). Replaces the retired Next.js editor.

Features

  • Visual canvas in block space: zoom/pan, grid + snapping, drag components, selection, keyboard nudge. Renders text (legacy & codes and MiniMessage, in the Minecraft font), item sprites, pixel-art image icons and animated icons at the exact in-game metrics (0.21875 blocks per text line, uiScale semantics, hitbox overlays matching the plugin's debugHitbox).
  • Linked button hitboxes: text and image click planes follow the visible render, while an optional custom width and height can replace automatic icon-derived sizing without creating an independent position that can drift away.
  • Runtime 3D preview: reproduces the open pose, followPlayer position and yaw, fixed / vertical / horizontal / center icon billboards, matching click planes, hover push and nearest-click behavior. PlaceholderAPI tokens remain literal because the browser has no server context; the preview reports their refreshTicks cadence instead.
  • Full format coverage as the plugin's Gson actually reads it — all three component types (button / decoration / toggle), all seven authorable icon types (text / textImage / animatedTextImage / item / block / customItem / entity), all six actions (command / sound / message / teleport / connect / navigate), toggle conditions, maxDistance, closeOnDeath, closeOnTeleport, customModelValue (the real key — the customModelData older files carry is migrated on import).
  • Code view with two-way sync, plus split view. Validated menu handoffs retain their exact source formatting and extension keys through storage and export until the first visual edit or explicit Format action.
  • Validation engine encoding the plugin's real parsing rules (lowercase registry keys, action source spellings, silent-zero pitfalls like volume: 0, legacy and MiniMessage formatting, hitbox overlap warnings).
  • Image library: upload validated PNG pixel art, preview exactly as the plugin rasterizes it, export images.zip laid out for plugins/holoui/images/. Server sync preserves captured PNG, JPEG, GIF, WebP and BMP bytes losslessly.
  • Workspace: folders, multiple menus and flow boards, atomic IndexedDB autosave with previous-transaction recovery and cross-tab conflict protection, undo/redo, templates, and searchable catalogs. Existing holoui.workspace.v1 / v2 localStorage data migrates once without deleting the rollback copy.
  • Optional server sync: capability links opened from /holoui edit import an exact menu or persistent world-board graph through the configured relay. Board publication retains the bound no-delete baseline and adds only menus reachable from the board root, leaving unrelated folder documents local. Sync status, conflicts and expiry stay visible; only the explicit Publish to Server action sends changes, and revision conflicts never overwrite local work. Links use the configured HTTPS relay (the plugin defaults to https://sync.holoui.volmitsoftware.com/v1) or a localhost HTTP development relay; an unreachable provider is reported without implying that a deployment is available.

The editor itself remains a static client with no accounts. Normal authoring and autosave are local-only; opening a server-issued capability link enables bounded HTTPS requests to that link's relay until the tab disconnects. Capability tokens stay in the URL fragment and tab sessionStorage, never in workspace documents or exported bundles. If tab storage is blocked, the capability stays in the fragment and the sync bar tells you to copy the link before reloading.

Sync v1 does not delete captured server resources. A board can add menus only under the displayed newMenuPrefix; menus and boards can add images only under newImagePrefix. The editor validates exact runtime ids, the whole bound graph, typed world-board JSON, image bytes, immutable constraints and content revisions before publishing. Synced raster assets are limited to 64×64 pixels each and 262,144 stored pixels per project; every repeated text-image component and animated frame is counted again against a 262,144-pixel / 4,096-row runtime-render budget. The protocol safety ceiling is 32 MiB per project; a relay deployment may enforce a lower configured limit and return 413.

Workspace bundles and server projects span IndexedDB documents and localStorage images. Import and refresh use checked compensation when either write fails, but browsers provide no atomic transaction across those two storage systems; force-closing the browser between their writes can leave a partial import.

Development

Requires Dart ≥ 3.10 and a checkout of arcane_jaspr at .deps/arcane_jaspr (a symlink to a local clone works):

git clone https://github.com/ArcaneArts/arcane_jaspr .deps/arcane_jaspr   # or: ln -s /path/to/arcane_jaspr .deps/arcane_jaspr
dart pub get
dart run jaspr_cli:jaspr serve      # dev server on :8080
dart test                           # core-logic test suite
dart run jaspr_cli:jaspr build      # static output in build/jaspr/

Releasing

The hosted editor is deployed to holoui.volmitsoftware.com on Firebase Hosting by .github/workflows/firebase-hosting.yml after every push to master. The workflow analyzes and tests the project before building, deploying, and verifying the custom-domain bundle. It requires the FIREBASE_SERVICE_ACCOUNT_HOLOUI_EDITOR repository secret. There are no editor releases: the plugin's /holoui builder command links players to the hosted editor.

Architecture

lib/model/        HoloUI JSON data model + codec (runtime semantics, unknown-key preserving)
lib/logic/        validation rules, Minecraft text parser, viewport math, hitbox geometry
lib/services/     browser storage, image library, catalogs, file transfer, clipboard
lib/state/        EditorStore, IndexedDB persistence, multi-doc workspace and flow boards
lib/components/   shell (top bar, shortcuts, palette), canvas, inspector, panels, dialogs
web/assets/       fonts (Geist, lucide, Minecraft), item/sound catalogs, backdrop, brand
tool/             asset extraction scripts

The format contract is derived from the plugin's Java parsing code (art.arcane.holoui.config.* via VolmLib's Gson setup), not from the shipped JSON schema. The schema is hand-maintained documentation; where the two disagree, this editor follows the code.

About

Web builder for creating and previewing HUI configs.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Used by

Contributors

Languages