Documentation

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

Overview

Document Description
User Manual Complete guide for using the app — install, manage, configure
Troubleshooting Fix common problems — connection, installs, crashes
Requirements Functional and non-functional requirements — what the app must do and how
Roadmap Version history, shipped features, and what’s planned next
Inspector XRay TCP agent discovery, Lua REPL, live log streaming — Xbox diagnostics built-in
Mobile Guide End-user guide for the Android app — APK install, QR connect, sideload, file explorer, logs

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

Mobile (Android)

The Android app (v2.0.0+) is a portrait-first port that reuses the desktop services and ViewModels behind a new phone-form-factor view layer.

Document Description
Mobile Guide End-user guide — install the APK, QR connect, browse, sideload, file explorer, logs, jobs
Android Architecture How the port reuses desktop services/VMs — shell, safe areas, back navigation, lifecycle
Services Adaptation Service consumption matrix on Android — SAF paths, storage, platform limits
Views Matrix Every mobile view vs its desktop counterpart — shipped status
Mobile UX Design Portrait-first design principles, tab structure, wizard/dialog system
Android Build & Release Signing, versionCode, APK naming, CI pipeline, sideloading
Android Testing Strategy Test approach, build constraints (AOT/trimming), device testing

Development

Document Description
Tech Debt Known issues ordered by severity — 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 Windows/macOS/Linux/Android support — porting history, blockers, CI matrix
Developer Architecture Shared service contracts, ViewModel boundaries, threading rules, Android reuse guidance
Portal Filesystem API The REST API behind the User Files portal browser — endpoints, auth, operations

Feature Specs

Document Description
File Explorer Browse the Xbox filesystem, transfer files via SFTP, USB drive access
Loopback Exempt Allow development-mode packages to reach the network via loopback exemption

Other

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