# MooshieUI MooshieUI is a beginner-friendly interface for image, video, music and 3D generation through [ComfyUI](https://github.com/comfyanonymous/ComfyUI), with optional image generation through the **NovelAI API** using your own key. It runs in two modes: - **Desktop app** via Tauri (Windows, Linux and [Apple Silicon macOS](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/MACOS.md); Mac builds are user-tested) - **Browser/server mode** via the built-in web server (LAN/Docker friendly, mobile UI) Built with **Svelte 5** + **Rust**, it hides ComfyUI's node-graph complexity behind a clean, guided workflow so you can generate without hand-editing graphs.  [](https://github.com/sponsors/Mooshieblob1) [](https://ko-fi.com/mooshieui)
MooshieUI is free and open source. If it saves you time or sparks joy, a sponsorship or a Ko-fi tip keeps the updates coming. No pressure, just gratitude. 🙏 (where does the money go?)
 --- ## 📚 Documentation Full guides live in the **[MooshieUI Wiki](https://github.com/Mooshieblob1/MooshieUI/wiki)**: | Guide | Covers | |-------|--------| | [Installation](https://github.com/Mooshieblob1/MooshieUI/wiki/Installation) | Desktop, Docker, remote/cloud ComfyUI, Apple Silicon macOS | | [Generation Basics](https://github.com/Mooshieblob1/MooshieUI/wiki/Generation-Basics) | Image modes, tabs and Profiles, pause/continue, queue, dimensions, guidance and the Characters tab | | [NovelAI Backend](https://github.com/Mooshieblob1/MooshieUI/wiki/NovelAI-Backend) | Personal API keys, characters, references, costs, face detailing and Director Tools | | [Video Generation](https://github.com/Mooshieblob1/MooshieUI/wiki/Video-Generation) | MiniMax H3, model stacks, timeline, interpolation, playback and export | | [Music Generation](https://github.com/Mooshieblob1/MooshieUI/wiki/Music-Generation) | YuE2 songs, lyric writing, playlists, shared playback and manual lyric timing | | [Anime Scenes](https://github.com/Mooshieblob1/MooshieUI/wiki/Anime-Scenes) | Voiced, lip-synced character clips through ElevenLabs and fal.ai with your own keys | | [Image to 3D](https://github.com/Mooshieblob1/MooshieUI/wiki/Image-to-3D) | Experimental textured meshes (Pixal3D) and Gaussian splats (Idol) from one image | | [Image Edit Mode](https://github.com/Mooshieblob1/MooshieUI/wiki/Image-Edit-Mode) | Qwen Image Edit, Flux Kontext, Flux.2 Klein, FLUX 3 Klein, Krea 2 edit LoRAs, MiniMax-H3-Image and Anima ReStyler | | [Prompting Guide](https://github.com/Mooshieblob1/MooshieUI/wiki/Prompting-Guide) | Prompt Chunks, random syntax, Artist Styles, Style Creator and interrogation | | [Prompt Assistant](https://github.com/Mooshieblob1/MooshieUI/wiki/Prompt-Assistant) | Local or external LLM-assisted prompt building | | [Models & the Model Hub](https://github.com/Mooshieblob1/MooshieUI/wiki/Models-and-the-Model-Hub) | Supported architectures, auto-detection, downloads | | [Upscaling & Face Fix](https://github.com/Mooshieblob1/MooshieUI/wiki/Upscaling-and-Face-Fix) | Tiled diffusion, guidance nodes, face fix | | [ControlNet & Style Transfer](https://github.com/Mooshieblob1/MooshieUI/wiki/ControlNet-and-Style-Transfer) | ControlNet and reference/style transfer | | [Inpainting & the Canvas Editor](https://github.com/Mooshieblob1/MooshieUI/wiki/Inpainting-and-the-Canvas-Editor) | Mask painting and selective edits | | [Compare Grid](https://github.com/Mooshieblob1/MooshieUI/wiki/Compare-Grid) | XYZ parameter sweeps | | [Image Comparison](https://github.com/Mooshieblob1/MooshieUI/wiki/Image-Comparison) | Slider, fade, difference and side-by-side comparison | | [Gallery & Metadata](https://github.com/Mooshieblob1/MooshieUI/wiki/Gallery-and-Metadata) | Persistent gallery, search, ratings, boards, linked folders, metadata import/remix | | [Server, LAN & Multi-User](https://github.com/Mooshieblob1/MooshieUI/wiki/Server,-LAN-and-Multi-User) | Self-hosting, roles, auth, mobile | | [Settings & Accessibility](https://github.com/Mooshieblob1/MooshieUI/wiki/Settings-and-Accessibility) | Persistence, themes, i18n, accessibility | | [AI Assistants & MCP](https://github.com/Mooshieblob1/MooshieUI/wiki/AI-Assistants-and-MCP) | Let Claude, Cursor and other assistants generate through the opt-in MCP server | | [FAQ](https://github.com/Mooshieblob1/MooshieUI/wiki/FAQ) | Common questions | | [Contributing](https://github.com/Mooshieblob1/MooshieUI/wiki/Contributing) | Setup, checks and the PR workflow | | [Project Scope](https://github.com/Mooshieblob1/MooshieUI/wiki/Project-Scope) | What MooshieUI is and is not | Technical references and project planning documents are indexed in [docs/README.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/README.md). --- ## ✨ Highlights > New features land in most releases. See [the release notes](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/RELEASE_NOTES.md) for what changed in the latest version. - **Image generation and editing** - text to image, image to image, inpainting with a built-in canvas/mask editor, and Image Edit for Qwen Image Edit/Edit Plus, Flux.1 Kontext, Flux.2 Klein, FLUX 3 Klein, Krea 2 (Identity Edit, General Edit and Style Reference LoRAs), MiniMax-H3-Image (up to 16 references) and Anima ReStyler. Work in several generation tabs at once and save a tab's settings as a Profile. - **NovelAI backend** - V5 Full/Curated, V4.5 Full and V4 Full, with character prompts and positioning, supported reference modes, Anlas estimates, Enhance/Upscale/Variations, Director Tools and a dedicated face detailer. Hosted users and moderators can save their own encrypted API key. - **Video generation** - MiniMax H3 text-to-video, first/last frames and reference images; preset or custom model stacks, a shot timeline, [Standard and Larryvrh/LightX2V/PDD Turbo methods](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/VIDEO.md), retained drafts with experimental 2× refinement, TeaCache, animated live previews, RIFE/GMFSS interpolation, a gallery player and MP4/animated-image export. - **Music studio** - YuE2 songs, native SheetSage2 covers and score-aware assistance through your configured Prompt Assistant. [Review and edit scores](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/MUSIC.md), preview melodies, export MIDI, generate sequential candidates, compare saved versions and export projects with original FLAC and settings. Review recognized lyrics and approximate cover timing using xAI transcription and your assistant, with playable evidence. Includes playlists, shared playback, manual lyric timing, reference-song lookup, temporary song-link imports, style analysis from selected audio sections, reusable style profiles, volume-matched A/B listening, scoped edits with before/after previews, and an arrangement-planning prototype. - **Image to 3D (experimental, off by default)** - turn one picture of a character or object into a textured mesh (`.glb`) with [Pixal3D](https://github.com/TencentARC/Pixal3D), or a 3D Gaussian splat with [Idol](https://huggingface.co/speridlabs/idol) (about 7 GB of VRAM), both on ComfyUI's own nodes. Spin it in the built-in viewer, keep it in a device-local library and export `.glb`, `.ply` or `.splat`. Start from a file, a paste or any gallery image. [Details](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/IMAGE_TO_3D.md). - **Anime Scenes (optional, cloud)** - turn a character into a short voiced, lip-synced clip with your own ElevenLabs (voice) and fal.ai Seedance 2.5 (video) keys, with optional NovelAI keyframes. Every paid step shows a cost confirmation first, and nothing in it runs on ComfyUI. - **AI assistants (MCP, off by default)** - a local, token-protected [MCP server](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/MCP.md) lets Claude Code, Claude Desktop, Cursor and similar assistants generate images and music, check the queue and search the gallery. Cloud assistants connect through an opt-in Cloudflare tunnel or your own address. - **Pause and continue** - pause ComfyUI text-to-image sampling, inspect a preview, change prompts or sampling settings, or paint a masked correction before continuing. Keep a pause to try different endings. - **Full generation controls** - searchable checkpoint/VAE/LoRA pickers with auto-download, all ComfyUI samplers and schedulers, steps/CFG/seed/batch, and smart dimension presets. - **Smart model detection** - 30+ model families, including Krea 2, FLUX 3 Klein, MOSS-Image, MiniMax-H3-Image and Kolors, identified through hashes, model metadata, tensor structure and filenames, with sampler/scheduler/CFG presets, split components, GGUF support and optional INT8-Fast loading. - **Prompt and style tools** - autocomplete, Prompt Chunks and wildcards, seeded random prompt syntax, scheduling, regional prompts, a local or external Prompt Assistant, Style Creator rounds for discovering artist combinations, and an image interrogator that returns tags, detected artists (Kaloscope) or a description in words. - **Characters** - save characters with a name, prompt, portraits and Markdown memory files, and reuse them across sessions and in NovelAI character boxes. - **Refinement and references** - MultiDiffusion/SpotDiffusion upscaling, SeedVR2 restoration, face detailing, ControlNet, IP-Adapter/Flux Redux style references, sampler guidance and the SDXL DMD2 preset. - **Compare Grid (XYZ)** - per-cell parameter sweeps stitched into a single labelled image. - **Queue and feedback** - reorder or cancel pending jobs, interrupt a run, watch previews and progress, and opt into completion notifications. - **Gallery & metadata** - Persistent image and video gallery with search, favourites, 1 to 5 star ratings, boards you can rename and delete, multi-select with bulk move, rate, favourite and delete (checkbox, Shift+click, Ctrl+click, Ctrl+A), Undo after a delete, a filter panel that folds away, board chips you can drop images onto (the busiest boards plus a searchable list once there are many), Reset filters, Undo and one-click removal for Sort by Artist and Sort by Character boards, arrow key navigation, export of a selection to a folder on desktop, a Repeats filter for images generated more than once with the same seed and settings, saved characters found in images by their prompt tags, or by a tagger scan for images with no saved prompt (filter, group or sort into boards by character), linked folders on desktop, a Refresh gallery action for externally added, restored or removed files, manual save mode, generation times and A/B comparison; import SwarmUI, A1111 and NovelAI settings, with original NovelAI PNG metadata preserved when copying. Refresh scans the current user's gallery folder and reloads embedded metadata without renaming files. An optional invisible watermark and an always-on gallery fingerprint can restore settings for an image that has lost its metadata. - **Self-hostable** - headless web server with roles, per-user galleries, auth, and a dedicated mobile layout. - **Themes** - dark and light modes, built-in palettes, and custom themes with your own background and logo that can be imported and exported. - **12 languages** - English, German, Spanish, French, Italian, Japanese, Korean, Polish, Portuguese, Russian, Simplified Chinese and Traditional Chinese, switchable without restart. Controls depend on the selected backend and model. NovelAI offers the three standard image modes; Image Edit, video, music, Image to 3D and pause/continue use ComfyUI; Anime Scenes uses cloud providers only. YuE2 requires its own checkpoint and native ComfyUI support; managed installs offer the tested runtime update. See the [Wiki](https://github.com/Mooshieblob1/MooshieUI/wiki) for each feature's requirements. --- ## 📦 Quick Start ### Desktop (Windows, Linux, Apple Silicon macOS) 1. Download a release from [Releases](https://github.com/Mooshieblob1/MooshieUI/releases): the `.exe` installer for Windows, an `.AppImage`, `.deb` or `.rpm` for Linux (or install it with `apt`, `dnf` or the AUR, see the [Linux guide](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/LINUX.md)), or the `_aarch64.dmg` for macOS 14 or later (see the [Mac guide](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/MACOS.md)). 2. Run the app. The setup wizard downloads uv, Python, ComfyUI, and PyTorch (NVIDIA, AMD, or Intel Arc GPU auto-detected; Apple Metal on Mac) and installs MooshieUI's custom nodes - no Python or pip setup required. On Windows, it also installs an app-local copy of Git when a working Git installation cannot be found. 3. Start generating; ComfyUI launches automatically. Managed ComfyUI uses port **18288** for new installations, preserves saved port settings, and chooses another free port if needed. Setup, restart, and shutdown stop only processes identified as MooshieUI's own, including verified keep-alive instances. Existing ComfyUI applications can stay running. To connect to one intentionally, choose **Remote** in the connection settings. The generation model picker uses the connected ComfyUI server's model inventory. A file downloaded locally may still be unavailable to that server; the picker and model manager show this separately. For an external server, install models on that server and refresh the model list. Startup progress appears above the page, keeping the tips readable while controls initialize. > Allow roughly 5–10 GB for the runtime, plus space for model downloads; first setup typically takes 5–15 minutes depending on your connection. GPU support varies by platform, including an allowlisted AMD Windows preview. See [Installation](https://github.com/Mooshieblob1/MooshieUI/wiki/Installation) for details. ### Generate with NovelAI Save your API key in **Settings > NovelAI**, then select a NovelAI model in the model picker. The generation page adapts to that backend and shows an estimated Anlas cost before submission. Local upscaling and face detection still need a running ComfyUI; NovelAI requests use your account's subscription and balance. See [NovelAI Backend](https://github.com/Mooshieblob1/MooshieUI/wiki/NovelAI-Backend). ### Self-host (Docker) ```bash cp .env.example .env # Edit .env: set MOOSHIEUI_ADMIN_USER and a strong MOOSHIEUI_ADMIN_PASS before first launch. docker compose up -d --build ``` Open `http://localhost:3200` (or the host port set by `MOOSHIEUI_PORT`) and sign in with the initial admin account. Empty passwords and `changeme` are not accepted for account creation. The supplied Docker stack targets NVIDIA GPUs and requires GPU support in Docker; it is separate from the desktop wizard's AMD/Intel setup. Full server/LAN/multi-user setup: [Server, LAN & Multi-User](https://github.com/Mooshieblob1/MooshieUI/wiki/Server,-LAN-and-Multi-User). ### Build from source Use Node.js 22.12+ or 24+, stable Rust, and the platform's Tauri v2 build prerequisites. See [CONTRIBUTING.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/.github/CONTRIBUTING.md) for validation and both Rust build targets. ```bash git clone https://github.com/Mooshieblob1/MooshieUI.git cd MooshieUI npm install npm run tauri dev # hot-reload dev npm run tauri build # production build ``` --- ## 🏗️ How it works 1. You adjust settings in the Svelte UI. 2. On Generate, `ipcInvoke()` sends settings to Rust through Tauri IPC on desktop or HTTP in browser mode; `ipcListen()` receives events through Tauri or SSE. 3. Rust builds an image, video, music or image-to-3D ComfyUI workflow from templates, or a NovelAI image request using the selected account's key. 4. ComfyUI workflows go to its `/prompt` API; NovelAI requests go to its image API. Optional local post-processing sends returned NovelAI images through ComfyUI. 5. ComfyUI WebSocket events and NovelAI streaming responses feed progress and previews. Images and videos use the gallery; music and 3D models each have their own device-local library. MooshieUI also ships custom ComfyUI nodes (tiled diffusion, soft/smart guidance, an SDXL↔Flux2 VAE adapter, Nanosaur DiT support, and face fix) that are auto-installed into ComfyUI. Details live in [Models & the Model Hub](https://github.com/Mooshieblob1/MooshieUI/wiki/Models-and-the-Model-Hub). The tiled diffusion node is also available as a standalone ComfyUI custom node: [ComfyUI-MooshieTiledDiffusion](https://github.com/Mooshieblob1/ComfyUI-MooshieTiledDiffusion). --- ## 🛠️ Tech Stack | Layer | Technology | |-------|------------| | Frontend | Svelte 5, TypeScript 6, Tailwind CSS 4 | | Runtime | Tauri desktop app + axum headless web server | | State | Svelte 5 runes - class-based singleton stores | | Persistence | Tauri Store (JSON), SQLite (`rusqlite`), and per-account IndexedDB for the music and 3D libraries | | Generation transport | ComfyUI REST/WebSocket and NovelAI HTTP/streaming through Rust | | Prompt Assistant | Local llama.cpp, configured external LLM endpoint, or [ChatGPT / Gemini account sign-in](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/PROMPT-ASSISTANT-SIGN-IN.md) | | Inference | ONNX Runtime (`ort`) for WD v3 image interrogation | | Autocomplete | Danbooru + Anima tag databases (~140k tags) | | i18n | 12 languages, checked key/placeholder parity, runtime switching | | Build | Vite 6 + `@sveltejs/vite-plugin-svelte` | --- ## 🔒 Security Automated **GlassWorm resistance checks** run on every push and pull request to catch supply-chain attacks that hide payloads in invisible Unicode variation selectors or tamper with git timestamps. The CI workflow (`.github/workflows/glassworm-scan.yml`) blocks merges on failure. Contributors should enable the same checks locally: ```bash bash scripts/setup-hooks.sh ``` --- ## 💛 Support & Where the Money Goes First off, to be clear: **this is not meant to be income.** MooshieUI is a passion project. I build it in my spare time around a regular day job, I don't expect to earn anything from it, and right now the running costs come straight out of my own pocket. If you support the project through [GitHub Sponsors](https://github.com/sponsors/Mooshieblob1) or [Ko-fi](https://ko-fi.com/mooshieui), here is exactly where it goes: - **Domain & hosting** - keeping the project site and download links online. - **SaaS & dev tooling** - the paid services and tools used to actually build and ship MooshieUI. - **GitHub Pro+** - CI/CD minutes for the build, release, and security-scan pipelines. [](https://ko-fi.com/R1F628M29D) The goal is simply to stop the project from costing me money to keep alive. Anything beyond covering costs just goes right back into building more features, faster. Longer term, the ideal is that MooshieUI can outlast my own availability. I intend to support this project for as long as I can, but every maintainer has lulls, and life can pull you away for a stretch. A small buffer means the domain, hosting, and infrastructure stay paid up through those quiet periods, so the project stays online and usable even when I am not actively maintaining it. Ko-fi is there for anyone who can't use GitHub Sponsors: it takes PayPal and cards, and you don't need an account. Supporting is completely optional and the app will always be free and open source either way. Thank you for even considering it. 🙏 --- ## 🤝 Contributing Pull requests are welcome. `main` is protected: open a PR from a `chore/