RomM server plugin

About This File

Hello everyone, I'm proud to present a new RomM server plugin for LaunchBox. Currently, it offers a complete solution, both synchronizing your server and updating it with LaunchBox data, as well as functions to install and uninstall games. Please take advantage of it and provide your feedback.

https://github.com/phscezario/launchbox-romm-plugin

## 🎉 v1.0.0 — First Stable Release!

After a lot of work, the plugin now reliably syncs metadata, cover art, and keeps your LaunchBox library in sync with your RomM server. 🚀

---

## 🎮 LaunchBox RomM Plugin — Release Notes

### 🆕 What's New

#### 📋 Metadata Sync (RomM → LaunchBox)
Sync now auto-fills LaunchBox game metadata from the RomM server:

- Release date, max players, play mode
- Video (YouTube), Wikipedia, ESRB
- Community rating and votes
- Synopsis / notes
- Genres, companies, game modes
- LaunchBox ID (LaunchBoxDbId)

Priority: **LaunchBoxMetadata > ScreenScraper > IGDB > RomM Metadata**.

#### 🖼️ Automatic Cover Art Download
- Box - Front cover art is downloaded automatically from the RomM server
- Only downloads if the game has no existing cover in LaunchBox
- `ForceReload` runs after sync so images appear immediately

#### 🧹 Orphan Image Cleanup
- When a game is removed from the RomM server, the sync removes the game from LaunchBox and deletes its associated images
- Cleanup happens **after** the full sync completes, preventing partial deletions on failure

#### ⚙️ KeepLocalData Flag
New setting that controls overwrite behavior:

- `KeepLocalData = true` — only fills empty fields, preserves existing data
- `KeepLocalData = false` — overwrites all fields

#### 🔄 Cover Art Upload (Update RomM Metadata)
`Update RomM Metadata` now also sends the Box - Front cover from LaunchBox back to the RomM server.

### 🐛 Fixes
- Fixed cover download failing due to unencoded spaces in RomM's timestamp parameter (`?ts=...`)
- Fixed image path by using LaunchBox's `GetNextAvailableImageFilePath` instead of hardcoded paths

### ⚡ Improvements
- `dataManager.ForceReload()` runs automatically after sync — no more restarting LaunchBox to see images
- Detailed logging of downloaded image paths for easier debugging

---

### How to Update

1. Replace the `RomM LaunchBox Integration` folder in your LaunchBox Plugins directory
2. Launch LaunchBox and configure `KeepLocalData` in plugin settings if desired
3. Run `RomM: Sync roms list from server`

Edited June 20 by ByakkoKa

What's New in Version 2.0.2 See changelog

Released Saturday at 11:21 AM

LaunchBox RomM Plugin v2.0.0

Major release with significant architectural improvements, new features, and a complete test suite.

🚀 New Features

Game Manager — New UI form (GameManagerForm) to browse, install, uninstall and manage ROMs directly from LaunchBox with progress tracking and queue support
Download Queue Service — Full download manager with concurrent downloads, pause/resume/cancel, progress tracking, persistent state, and retry logic
Play Session Tracking — Track play sessions (start time, end time, duration, save slot) and sync them to the RomM server
Auto-Update System — Checks GitHub Releases for new versions, downloads and stages updates with UI notifications
Localization (i18n) — Complete internationalization system with en.json and pt-BR.json locale files, fallback chain, and language selection in settings
Remove All — New admin action (--remove-all) to fully clean installed ROMs, restart LaunchBox and reset UI state
Install/Uninstall Menu Items — Dedicated menu buttons for RommInstallMenuItem and RommUninstallMenuItem with per-platform operations
Backup Service — New IRommBackupService / RommBackupService for creating backups before destructive operations
Screenshot Sync — RommScreenshotSync service to upload and sync screenshots between LaunchBox and RomM
Stats Service — RommStatsService to fetch and display play statistics (play count, total time, last played)
Metadata Mapper — RommMetadataMapper with diff-based comparison for efficient metadata synchronization
Platform Prefix for Apps — Automatically prefix app names with platform name to avoid conflicts across systems
ForcePushToServer — New admin setting to force-push metadata even when no local changes are detected

🔧 Architecture & Refactoring

Dependency Injection — Introduced ServiceLocator for centralized service resolution
Interface-driven design — All major services now have corresponding interfaces (IRommSyncService, IRommStatsService, IRommBackupService, IRommHierarchyCli, IRommScreenshotSync, IRommMetadataMapper, etc.)
SDK-style csproj — Migrated all projects to modern SDK-style project format
Singleton guards — Added thread-safe singleton guards for Sync, Reset and Settings services
DI cleanup — Removed RommInstaller and legacy code, replaced with proper service abstractions
Unified build output — All projects output to build/Release without TFM subfolder
SafeFileWriter — Atomic file writes with temp file + rename pattern to prevent corruption
SecureCredentialStorage — Encrypted credential storage for API tokens
AuthHeaderHelper — Centralized authentication header injection

🧪 Testing

New test project — RommPlugin.Tests with xUnit + Moq
15+ test classes covering:
- RommApiClientTests — API client request/response handling
- RommGameHelpersTests — Game matching and path resolution logic
- RommMetadataMapperTests — Metadata diff and mapping logic
- RommSyncServiceStatsTests — Sync statistics calculation
- DownloadItemTests — Download state management
- RommPluginSettingsTests — Settings serialization/deserialization
- LocaleManagerTests — i18n loading and fallback
- SafeFileWriterTests — Atomic write operations
- SecureCredentialStorageTests — Credential encryption
- AuthHeaderHelperTests — Header injection
- And more...

📚 Documentation

Complete docs folder with:
- architecture.md — System architecture and project structure
- development-setup.md — Prerequisites and IDE configuration
- contributing.md — Commit conventions, code style, PR process
- testing.md — How to run and write tests
- ci-cd.md — GitHub Actions workflows
- configuration.md — Full settings.json reference
- deployment.md — Build and release process
- release-process.md — Versioning and tagging
- localization.md — i18n system guide
- api-integration.md — RomM API endpoints reference

🔄 CI/CD & DevOps

ci.yml — Build and test pipeline
test.yml — Automated test execution
release.yml — Release artifact publishing
auto-tag.yml — Automatic version tagging
.editorconfig — Enforced code style consistency

🐛 Bug Fixes

Reuse existing playlist GUIDs in Parents.xml instead of generating new ones
Removed TrySetResult call in ProgressRunner.FormClosing to prevent race conditions
Proper handling of cancelled download status and actions
Fixed singleton initialization guards across services

📦 Project Changes

Version bump to 2.0.0
Added settings.example.json for reference
Added Sync-LaunchBoxMetadata.ps1 PowerShell helper script
Removed legacy packages.config (NuGet PackageReference migration)
Cleaned up unused usings and dependencies
Added XML documentation comments throughout codebase

Sign In

RomM server plugin 2.0.2