Repository navigation
Home
github-actions[bot] edited this page Oct 14, 2026
·
33 revisions
Developer and user documentation for the main projects:
-
SimpleLauncher— WPF desktop app (the launcher) -
SimpleLauncher.Core— class library (services, models, persistence) -
SimpleLauncher.Avalonia— cross-platform Avalonia port (Windows x64/ARM64, Linux x64/ARM64 — Linux is beta); remaining work is tracked inReferences/TODO.md
Companion files: ManualTests.md (manual test checklist for areas without unit tests) · WhatsNew.md (changelog) · parameters.md (emulator parameter reference).
- User-facing: 01 → 03 → 05 → 18
- Architecture: 04 → 02 → 06 → 07
- Feature deep-dives: 08 → 09 → 10 → 11 → 12 → 13
- Maintenance: 14 → 15 → 16 → 17
| Doc | Content |
|---|---|
| 01 — Overview | What Simple Launcher is, differentiators, feature surface, version/license |
| 02 — Projects & Solution | Solution layout, csproj deep-dive for both projects, packages, folder structure |
| 03 — Quickstart | Install, prerequisites, first launch, Easy/Expert Mode, folder structure |
| 04 — Architecture | Layers, DI composition root, startup/shutdown sequence, host-interface pattern, MVVM |
| 05 — Configuration | appsettings.json, settings.xml, system.xml schema, placeholders, data-file locations, credentials |
| 06 — Systems & Launch | System model, launch pipeline, 8 launch strategies, extraction/mounting/conversion, 21 emulator config handlers, AI parameter resolution |
| 07 — Core Services | Complete catalog of SimpleLauncher.Core\Services\ (grouped) + interfaces + models |
| 08 — UI Layer | Windows, pages, ViewModels, UI services, menus, themes, languages |
| 09 — RetroAchievements | RA API client, system matcher, hashing, credential injection, RA windows |
| 10 — Game Scanning | GameScannerService + the 11 storefront scanners |
| 11 — Bundled Tools | Shipped tools\ payloads, ExternalToolLauncherService, Tools\ source projects |
| 12 — Data Formats | XML / MessagePack / SQLite / JSON / YAML / TOML usage across the app |
| 13 — Logging & Debug | Serilog setup, sinks, Debug Window, bug-report pipeline |
| 14 — Testing | Test projects (fast/slow split), helpers, coverage summary, running tests |
| 15 — Development | Build/publish, versioning, localization, analyzers, release workflow |
| 16 — Updater | Update check, Updater.exe flow, restart/reinstall |
| 17 — Release Notes | Condensed changelog 5.8.0 → 1.1 |
| 18 — Emulator Parameters | parameters.md conventions + full system → emulator index (84 systems / 352 entries) |
- Code facts are cited with
path:linereferences into the repository. -
⚠marks behavior that should be verified before relying on it. - Relative links (
xx-*.md) work from withindocs\;../links point to the repo root. - Version-specific numbers (package versions, test counts) reflect the repository at doc-write time (5.8.0).
- Home
- 01 — Overview
- 02 — Projects & Solution
- 03 — Quickstart
- 04 — Architecture
- 05 — Configuration
- 06 — Systems & Launch
- 07 — Core Services
- 08 — UI Layer
- 09 — RetroAchievements
- 10 — Game Scanning
- 11 — Bundled Tools
- 12 — Data Formats
- 13 — Logging & Debug
- 14 — Testing
- 15 — Development
- 16 — Updater
- 17 — Release Notes
- 18 — Emulator Parameters
- GUI Test Harness
- Manual Tests
- Parameters