# MooshieUI documentation Documentation for the current implementation. Start with the [repository README](https://github.com/Mooshieblob1/MooshieUI/blob/main/README.md) for an overview or the [user wiki](https://github.com/Mooshieblob1/MooshieUI/wiki) for installation and feature walkthroughs. ## Feature and technical references | Document | Purpose | |----------|---------| | [MCP.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/MCP.md) | The opt-in local MCP server for AI assistants: setup, tools, generation setups and connecting clients | | [METADATA_CARRIERS.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/METADATA_CARRIERS.md) | Where generation metadata lives per output format, and what survives | | [NOVELAI.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/NOVELAI.md) | NovelAI architecture, personal keys, face detailing, local post-processing and historical test notes | | [RANDOM_PROMPTS.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/RANDOM_PROMPTS.md) | Seeded alternation, multiple choices, weights, nesting and escapes | | [STYLE_REFERENCE.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/STYLE_REFERENCE.md) | IP-Adapter/Flux Redux support, model files and controls | | [MACOS.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/MACOS.md) | Apple Silicon installation, validation and support status | | [IMAGE_TO_3D.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/IMAGE_TO_3D.md) | Experimental Image to 3D: Pixal3D meshes, Idol splats, model files and the viewer | | [YuE2 integration](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/research/yue2-integration.md) | Native ComfyUI music support, model setup, and validation limits | | [Music studio guide](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/MUSIC.md) | Covers, reviewed scores, checked edits, MIDI, versions, comparisons and project exports | | [Prompt Assistant account sign-in](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/PROMPT-ASSISTANT-SIGN-IN.md) | ChatGPT and Gemini sign-in, automatic setup, account limits and audio support | | [Video generation methods](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/VIDEO.md) | Standard, Larryvrh/LightX2V/PDD Turbo, BF16/INT8 VDN and retained 2× drafts | | [ElevenLabs prompting rules](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/ELEVENLABS_PROMPTING_AGENTS.md) | Voice Design and speech rules the anime scene builders follow, with sources and the minor-safety rule | | [Seedance prompting rules](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/SEEDANCE_PROMPTING_AGENTS.md) | Video prompt rules, provider limits and safety rules the anime scene builder follows | The wiki also covers [music and playlists](https://github.com/Mooshieblob1/MooshieUI/wiki/Music-Generation), [video](https://github.com/Mooshieblob1/MooshieUI/wiki/Video-Generation), [pause and continue](https://github.com/Mooshieblob1/MooshieUI/wiki/Generation-Basics#pause-and-continue-a-generation), [Style Creator](https://github.com/Mooshieblob1/MooshieUI/wiki/Prompting-Guide#style-creator), [Image Edit](https://github.com/Mooshieblob1/MooshieUI/wiki/Image-Edit-Mode), [Anime Scenes](https://github.com/Mooshieblob1/MooshieUI/wiki/Anime-Scenes), [Image to 3D](https://github.com/Mooshieblob1/MooshieUI/wiki/Image-to-3D), [AI assistants and MCP](https://github.com/Mooshieblob1/MooshieUI/wiki/AI-Assistants-and-MCP), and [hosted accounts](https://github.com/Mooshieblob1/MooshieUI/wiki/Server,-LAN-and-Multi-User). ## Planning and maintenance These documents include proposals and historical evidence; they are not promises of available features. | Document | Purpose | |----------|---------| | [ROADMAP-2026-gaps.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/ROADMAP-2026-gaps.md) | Original gap analysis with current implementation status | | [FEATURE_RESEARCH.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/FEATURE_RESEARCH.md) | Historical research shortlist; its ecosystem table is a snapshot | | [Video improvements](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/research/video-improvements.md) | Ranked follow-ups, source evidence and GPU qualification plan | | [Automatic music style from audio](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/research/suno-audio-style.md) | Suno evidence, audio conditioning versus metadata reuse, and the first audio-analysis implementation | | [Music generation improvements](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/research/music-generation-improvements.md) | Continued Suno, Udio and Lyria 2 research, practical priorities and validation boundaries | | [RTX 5070 video comparison](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/research/video-benchmark-2026-09-15.md) | Measured generation times, motion observations and VDN compatibility failures | | [Cover audio review and timing](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/research/music-cover-review.md) | Implemented xAI review, timing limits, and the decision to abandon experimental audio timing repair | | [Anime scene pipeline](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/research/anime-scene-pipeline.md) | Original proposal and prototype record for the Scenes page (voiced, animated character clips with ElevenLabs and cloud video), which shipped in v2.3.20; kept as history | | [MACOS_RELEASE_PLAN.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/MACOS_RELEASE_PLAN.md) | Apple Silicon release requirements and outstanding qualification gates (DMGs ship with every release since v2.3.9) | | [BOT_REVIEW_TRIAGE.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/BOT_REVIEW_TRIAGE.md) | Triage notes for automated PR review comments | | [issue_cleanup_followup_tracks.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/issue_cleanup_followup_tracks.md) | Historical issue follow-up tracks | Local implementation plans and specs may also exist under `docs/superpowers/`. That directory is git-ignored and is not part of a fresh clone's published documentation. ## Elsewhere | Topic | Path | |-------|------| | User-facing readme | [README.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/README.md) | | Contributing / PR workflow | [push-instructions.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/push-instructions.md) | | Contributor checks / scope | [CONTRIBUTING.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/.github/CONTRIBUTING.md), [SCOPE.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/SCOPE.md) | | Changelog / release notes | [CHANGELOG.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/CHANGELOG.md), [RELEASE_NOTES.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/docs/RELEASE_NOTES.md) | | Agent entry | [AGENTS.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/AGENTS.md) | | Copilot / Gemini overview | [GEMINI.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/GEMINI.md), [.github/copilot-instructions.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/.github/copilot-instructions.md) | | Full agent conventions | [.github/instructions/mooshieui.instructions.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/.github/instructions/mooshieui.instructions.md) | | Layer-specific rules | [.github/instructions/](https://github.com/Mooshieblob1/MooshieUI/blob/main/.github/instructions/) | | Smoke test runbook | [scripts/SMOKE_TEST_RUNBOOK.md](https://github.com/Mooshieblob1/MooshieUI/blob/main/scripts/SMOKE_TEST_RUNBOOK.md) | | Self-host deployment (Docker image, Kubernetes) | [deploy/](https://github.com/Mooshieblob1/MooshieUI/blob/main/deploy/) | ## Keeping documentation current For a user-facing change, update the relevant wiki page and its navigation, the README if it changes a headline capability or setup step, and any technical reference above. Check the code and shipped release notes for backend/model restrictions and exact control names. Keep dated experiments and plans identified as history rather than rewriting them as current behavior. The wiki is a separate Git repository (`https://github.com/Mooshieblob1/MooshieUI.wiki.git`). Changes here do not automatically publish wiki changes, and wiki edits do not update this repository. Check relative links, wiki page names and section anchors in both before publishing.