Documentation

Everything you need to understand, build, and contribute to XB Homebrew Vault.

Overview

Document Description
Requirements Functional and non-functional requirements — what the app must do and how
Roadmap Version history, shipped features, and what’s planned next

Architecture

Document Description
Architecture Layered architecture, MVVM structure, service map, startup flow, CI — with Mermaid diagrams
API Reference Full Xbox Device Portal REST + WebSocket endpoint reference with request/response examples
Data Sources Emulation Revival catalog.json API, cache structure, package manifest format
Blades Theme Color palette, typography, title bar gradient, component styles
Window Template AXAML template for new windows — drag, close button, green border pattern

How It Works

Deep-dives into the trickier integration challenges — how the app actually talks to the Xbox.

Document Description
Package Installation Flow Dependency detection, main package + dependency install, registration, wait/retry logic, and how failures are handled
SSH/SFTP & Path Handling Path handling over SFTP, the cmd.exe shell layer, dir-style command quirks, and USB drive discovery
USB Device Discovery WMI-based drive detection, permission setup with icacls, and the Windows-side discovery flow

Development

Document Description
Tech Debt Known issues ordered by severity — 16 open items with file:line references and fix recommendations
Branching & Versioning Git branch strategy, SemVer rules, commit message conventions, release workflow
Assets Guide Icon naming conventions, size selection, directory structure, format rules
Cross-Platform Porting Plan to support Linux and macOS builds — blockers, steps, CI matrix

Feature Specs

No published feature specs yet — coming in a future update.

Other

Document Description
Attributions Credits for icons, data sources, frameworks, and background images