Commit eb5d084
committed
docs: mark Linux support as beta for the 5.8.0 release
- WhatsNew: the Linux section is now "Linux Support (Avalonia) - Beta" with a beta note (tested end-to-end on Ubuntu 24.04 x64; the ARM64 bundle is structurally verified only; report issues on GitHub).
- README, docs/01 and docs/03: beta wording on the platform coverage/prerequisites; docs/03 also corrected the Linux prerequisite (the release bundle is self-contained, so no .NET install is needed).
- docs/17: added the condensed Linux (beta) entry and refreshed the localization key count (2671) and Meziantou.Analyzer version (3.0.264).1 parent 0d70341 commit eb5d084
5 files changed
Lines changed: 9 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -203,7 +203,7 @@ Simple Launcher is translated into **18 languages**: | |||
| 203 | 203 | ||
| 204 | 204 | An **Avalonia-based cross-platform port** (`SimpleLauncher.Avalonia`) is being developed alongside the WPF app. It reuses all business logic, models, data access, and emulator config handling from `SimpleLauncher.Core`: | |
| 205 | 205 | ||
| 206 | - - **Platforms:** Windows (x64/ARM64) and Linux (x64/ARM64) — dual-target `net10.0` (Linux) + `net10.0-windows` (Windows) | ||
| 206 | + - **Platforms:** Windows (x64/ARM64) and Linux (x64/ARM64) — dual-target `net10.0` (Linux) + `net10.0-windows` (Windows). **Linux support is beta**: verified end-to-end on Ubuntu 24.04 x64 (the `linux-arm64` bundle is structurally verified only) — please report issues on GitHub | ||
| 207 | 207 | - **Windows delivery:** ships in the same unified release zip as the WPF app (`SimpleLauncher.Avalonia.exe` next to `SimpleLauncher.exe`); both are framework-dependent single executables that share the same content files and settings. A single `Updater.exe` updates either app. | |
| 208 | 208 | - **Port status:** menu bar with full options (language, button size, aspect ratio, view mode, filename preferences, RetroAchievements, donate, about — the emulator config injection and tools menus are Windows-only and hidden elsewhere), per-game context menus (launch, favorites, details, RetroAchievements, copy path/name, show in folder, edit system), 15 utility windows, Favorites / Play History / Global Search pages, RetroAchievements UI (profile / unlocks / progress + settings; the emulator-integration section is Windows-only), tray icon with native menu, F8 global screenshot hotkey (Windows), single dark theme, fully localized UI via the shared JSON packs (18 languages, 2671 keys each, `SimpleLauncher.Core\Localization`) | |
| 209 | 209 | - **Linux/macOS specifics:** ZIP/7Z/RAR launch extracts to a temp folder, CHD is converted on the fly (CHDSharp) and ISOs are mounted inside DOSBox — the Windows mounting tools (Dokan, CHDMounter, SimpleZipDrive, SimpleXisoDrive) are not used; MP3/WAV UI sounds play with no extra packages (FLAC/Ogg/Opus need the system `libsndfile`, `sudo apt install libsndfile1`) | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -32,7 +32,8 @@ | |||
| 32 | 32 | - **Avalonia fixes** — Edit System help rendering, status bar visibility in the system selection screen, no-credentials panel in the RA window, loading the clicked system card after closing Edit System, in-app path guards, INI encoding, and a window title matching WPF. | |
| 33 | 33 | - **Filtering** — Accent-insensitive game filtering restored, and Commander Genius archive deletion fixed. | |
| 34 | 34 | ||
| 35 | - ## Linux Support (Avalonia) | ||
| 35 | + ## Linux Support (Avalonia) — Beta | ||
| 36 | + - **Beta** — Linux support is in beta: it was tested end-to-end on Ubuntu 24.04 x64; the ARM64 bundle is structurally verified only. Please report issues on GitHub. | ||
| 36 | 37 | - **Native Linux builds** — The Avalonia app now ships self-contained bundles for `linux-x64` and `linux-arm64` (`release_{version}_linux-*.zip` plus `updater_linux-*.zip`); the release workflow publishes them next to the Windows bundles and the in-app updater resolves the Linux assets. | |
| 37 | 38 | - **No Dokan needed on Linux** — ZIP/7z/RAR games extract to a temp folder on launch, CHD images are converted on the fly with the managed CHDSharp library and mounted natively in DOSBox (`imgmount`), and DOSBox ISO games use the same native mount instead of the Windows PowerShell path. | |
| 38 | 39 | - **Native Linux behavior** — App data lives in the XDG folder (`~/.local/share/SimpleLauncher`), Commander Genius uses `~/.CommanderGenius`, paths are handled POSIX-style with case-sensitive matching, and the extension-less bundled 7-Zip fallback (`7zz`) runs correctly. SDL2 gamepad navigation is supported. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -25,7 +25,7 @@ Three code projects implement it: | |||
| 25 | 25 | - **Easy Mode wizard** — guided download & configuration of emulators, cores, and image packs. | |
| 26 | 26 | - **Expert Mode** — full manual control of `system.xml`: multiple ROM folders, placeholders (`%BASEFOLDER%`, `%SYSTEMFOLDER%`, `%EMULATORFOLDER%`, `%ROM%`, `%NAME%`, `%ROMSYSTEMFOLDER%`), launch parameters. | |
| 27 | 27 | - **Performance** — MessagePack binary storage (`favorites.dat`, `playhistory.dat`, `history.dat`, `mame.dat`, `RetroAchievements.dat`), async scanning/loading, pagination. | |
| 28 | - - **Platform coverage** — native **x64 and ARM64** builds for Windows 10+ (WPF + Avalonia) and Linux (Avalonia, x64/ARM64); .NET 10 runtime. | ||
| 28 | + - **Platform coverage** — native **x64 and ARM64** builds for Windows 10+ (WPF + Avalonia) and Linux (Avalonia, x64/ARM64); .NET 10 runtime. **Linux support is beta**: verified end-to-end on Ubuntu 24.04 x64, the `linux-arm64` bundle is structurally verified only. | ||
| 29 | 29 | ||
| 30 | 30 | ## Feature surface (summary) | |
| 31 | 31 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -8,7 +8,7 @@ | |||
| 8 | 8 | - **Windows 10 or 11** (x64 or ARM64 — native ARM64 builds are provided). | |
| 9 | 9 | - **.NET 10 Desktop Runtime** (the app targets `net10.0-windows`, runtime `10.0.2`). | |
| 10 | 10 | - **Dokan** (optional but recommended) — required for on-the-fly mounting of `.iso`, `.xiso`, `.zip`, and universal CHD mounting. The app detects Dokan and shows a specific message when it is missing. | |
| 11 | - - **Linux/macOS (Avalonia app):** the .NET 10 runtime; **`libasound2`** for audio output and the optional **`libsndfile1`** for FLAC/Ogg/Opus sound effects (MP3/WAV need no extra packages). Mounting tools are Windows-only — `.zip`/`.7z`/`.rar` launch extracts to a temp folder, CHD is converted on the fly, and `.iso` is mounted inside DOSBox. | ||
| 11 | + - **Linux/macOS (Avalonia app):** no .NET install needed for the self-contained release bundles; **`libasound2`** for audio output and the optional **`libsndfile1`** for FLAC/Ogg/Opus sound effects (MP3/WAV need no extra packages). Mounting tools are Windows-only — `.zip`/`.7z`/`.rar` launch extracts to a temp folder, CHD is converted on the fly, and `.iso` is mounted inside DOSBox. **Linux support is beta** (verified on Ubuntu 24.04 x64; please report issues). | ||
| 12 | 12 | - A writable folder for the app (the launcher refuses to run from a temp folder and detects non-writable installs). | |
| 13 | 13 | - Your own **emulators and ROMs** (the launcher ships none). | |
| 14 | 14 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,10 +7,11 @@ | |||
| 7 | 7 | - **Unified Windows release**: one zip ships `SimpleLauncher.exe` (WPF) and `SimpleLauncher.Avalonia.exe` (Avalonia) side by side with a single shared `Updater.exe` that relaunches whichever app started it; single-instance guard shared across both apps. | |
| 8 | 8 | - **Unified SQLite settings database** (`settings.dat`, WPF + Avalonia): favorites, play history, app/emulator settings, per-system play times and system configs in one store; automatic legacy migration (`settings.xml`, `system.xml`, `favorites.dat`, `playhistory.dat`) with verification + `.bak` shelving, merge into an existing database, read-only recovery, and cross-app rename/delete consistency. | |
| 9 | 9 | - **WPF top-bar card-size slider** for game thumbnails (debounced, synced with the menu and Ctrl+wheel). | |
| 10 | - - **Shared localization packs**: one JSON pack set (18 languages, 2669 keys) in `SimpleLauncher.Core\Localization`; WPF embeds them, Avalonia embeds them in the assembly; old `strings.*.xaml` packs removed; Avalonia message boxes fully localized. | ||
| 10 | + - **Shared localization packs**: one JSON pack set (18 languages, 2671 keys) in `SimpleLauncher.Core\Localization`; WPF embeds them, Avalonia embeds them in the assembly; old `strings.*.xaml` packs removed; Avalonia message boxes fully localized. | ||
| 11 | 11 | - **Reliability/security hardening**: Zip-Slip fail-closed extraction without wiping destination folders, partial-file cleanup, download cancel/path sanitization, updater staged-swap rollback, launch gating + invalid executable handling, gamepad/hash-pipe deadlocks, shutdown/tray-icon stall, play-history locking, RA account/system/hash hardening. | |
| 12 | - - **Avalonia fixes**: Edit System help rendering, system-selection status bar, RA no-credentials panel, clicked-card load after Edit System, in-app path guard, INI encoding, WPF-matching title. | ||
| 13 | - - **Tooling**: vendored PBPSharp replaced by NuGet 1.1.1; Meziantou.Analyzer 3.0.259, NetAnalyzers 10.0.401, Microsoft.Extensions 10.0.12, Http.Resilience 10.10.0, NAudio 3.1.0. | ||
| 12 | + - **Avalonia fixes**: Edit System help rendering, system-selection status bar, RA no-credentials panel, clicked-card load after Edit System, in-app path guard, INI encoding, WPF-matching title; embedded tray/about/link icons, wait overlay for long operations, selected-system info panel. | ||
| 13 | + - **Linux support (beta)**: self-contained Avalonia bundles for `linux-x64` / `linux-arm64` plus the Linux `Updater` in the same GitHub release; native launch pipeline (temp extraction, managed CHDSharp conversion, DOSBox `imgmount`, bundled `7zz`), XDG data folder, managed MP3/WAV audio, SDL2 gamepad navigation, platform-aware pickers/validation. Windows-only features (Dokan mounting, storefront scanning, RA config injection, screenshot/hotkey, Tools menu) are hidden/no-ops. **Beta** — verified on Ubuntu 24.04 x64; ARM64 structurally verified only; please report issues. | ||
| 14 | + - **Tooling**: vendored PBPSharp replaced by NuGet 1.1.1; Meziantou.Analyzer 3.0.264, NetAnalyzers 10.0.401, Microsoft.Extensions 10.0.12, Http.Resilience 10.10.0, NAudio 3.1.0. | ||
| 14 | 15 | ||
| 15 | 16 | ## 5.7.0 — 2026-09-07 | |
| 16 | 17 | ||
0 commit comments