How victorsigma/ui-crafter works
Project type and purpose
• This is a single‐page full-feature frontend application (no custom backend code).
• Purpose: Provide a React-based visual editor ("UI Crafter") for designing Minecraft Bedrock UI forms and linking them to game functions via a node-based system. It also lets users write and manage game code snippets and export them.
File structure
• Top‐level:
• public/ → static assets, themes, index.html for Firebase Hosting
• src/ → main source: assets, components, libs, models, services, view, entry point (main.tsx)
• config files → package.json, tsconfig, vite.config, firebase.json
• src/components: UI controls (cards, dropdowns, sliders, modals, headers, editor nodes)
• src/services: business logic (ProjectDB, ExportManager, UndoRedoStack)
• src/libs: utility functions (file manager, string manager, node editor)
• src/models: TypeScript interfaces for domain objects (ProjectModel, Form, MenuItem, etc.)
• src/view: high-level views (ProjectView)
• Routing: react-router.config.ts
• Styles: ore-styles.css, tool-styles.css
README for additional insights
• Tech stack: React, Vite, Styled Components, TypeScript, React Router
• Mentions Minecraft Bedrock UI API integration (@minecraft/server-ui)
• Demo hosted on Firebase → uses Firebase Hosting (no backend functions)
Main components and their interactions
a. Components
• Browser / Client (served via Firebase Hosting)
• React SPA core (App → Router → ProjectView)
• UI Layer (src/components/**): Editor Canvas, Node Editor, Form Panels, Modals, Toolbars
• Services Layer (src/services):
– ProjectDB: load/save project definitions (IndexedDB or localStorage)
– ExportManager: generate TS/JS code for Minecraft UI and functions
– UndoRedoStack: command history for UI changes
• Libraries (src/libs): utility functions for file I/O simulation, theming, string building, node graph management
• Models (src/models): shared type definitions
• Assets (public/assets): theme JSON files, images, fonts
• External API: Minecraft Bedrock UI API (used in generated code, not at runtime)
b. Relationships / Data flow
1. User interacts with UI components → triggers actions in Services
2. Services update Models → propagate back to UI (via React state/context)
3. UI Canvas renders components based on Models
4. ExportManager reads Models → produces code artifact → user downloads or copies
5. ProjectDB persists Models state between sessions
6. UndoRedoStack intercepts commands → enables rollback in UI
Architectural patterns and design principles
• Layered architecture:
• Presentation (React components)
• Domain (Models + Services)
• Infrastructure/Utilities (libs + ProjectDB storage)
• Unidirectional data flow (React + context/state + custom services)
• Modular component design (atomic card, dropdown, slider, editor nodes)
• Plugin/extension points: themes folder, custom node editor modules
• Code-generation pattern: UI Model → AST/string builder → export