Repository navigation
docs(release): make the 1.17.0 release page user-facing #59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,33 @@ | ||
| # OpenBox release notes | ||
|
|
||
| OpenBox 1.17.0 brings installed GOG, EA app, and Ubisoft Connect games into the library on Windows, remembers Game Night decks, records what each game cost, and translates server notices. It also fixes ScreenScraper lookups. Upgrade from any 1.16.x release. The full list is in [CHANGELOG.md](https://github.com/vindeckyy/OpenBoxGL/blob/master/docs/CHANGELOG.md), and the code changes are in [v1.16.1...v1.17.0](https://github.com/vindeckyy/OpenBoxGL/compare/v1.16.1...v1.17.0). | ||
| OpenBox 1.17.0 imports installed GOG, EA app, and Ubisoft Connect games on Windows, remembers Game Night decks, records what each game cost, and translates server notices. It also fixes ScreenScraper lookups. Upgrade from any 1.16.x release. The full list is in [CHANGELOG.md](https://github.com/vindeckyy/OpenBoxGL/blob/master/docs/CHANGELOG.md), and the code changes are in [v1.16.1...v1.17.0](https://github.com/vindeckyy/OpenBoxGL/compare/v1.16.1...v1.17.0). | ||
|
|
||
| ## Your other launchers | ||
|
|
||
| Windows now imports games installed by GOG Galaxy, the EA app, and Ubisoft Connect. Open **Tools > Import GOG**, **Import EA app**, or **Import Ubisoft Connect**. The same buttons sit in the Storefront Manager. Importing again finds the same records by their store id, so no duplicates are added. | ||
| Windows now imports games installed by GOG Galaxy, the EA app, and Ubisoft Connect. Open **Tools > Import GOG**, **Import EA app**, or **Import Ubisoft Connect**. The same buttons sit in the Storefront Manager. Importing again matches the launcher's store id, so a second import does not add duplicates. | ||
|
|
||
| - **GOG** reads the install entries and the game's own `goggame-*.info` file. The game executable runs directly; an executable outside the install folder is refused. | ||
| - **EA app** reads the launcher's `installerdata.xml` and launches through the EA app. | ||
| - **Ubisoft Connect** reads the launcher's install entries and launches through Ubisoft Connect. | ||
| GOG reads the install entries and the game's own `goggame-*.info` file; its executable runs directly and must stay inside the install folder. The EA app reads its `installerdata.xml` and launches through the EA app. Ubisoft Connect reads its install entries and launches through Ubisoft Connect. A malformed entry is skipped with an error, not a crash. | ||
|
|
||
| Import is read-only and offline. A malformed entry is skipped with an error, not a crash. Uninstalling the EA app or Ubisoft Connect breaks those launches until the launcher comes back. | ||
| The import is read-only and offline. Uninstalling the EA app or Ubisoft Connect breaks those launches until the launcher returns. | ||
|
|
||
| ## Game Night decks | ||
|
|
||
| Save the rules for your couch night as a named deck: players, session length, and a filter such as `platform:SNES`. Pick the deck next time and OpenBox fills the setup back in. **Save deck** and **Delete deck** sit under the setup controls. | ||
| Save the rules for a couch session as a named deck: players, session length, and a filter such as `platform:SNES`. Choosing the deck next time restores those settings. **Save deck** and **Delete deck** sit under the setup controls. | ||
|
|
||
| Every draw returns an eight-character **seed**. On another device with the same library, entering the same seed and filter produces the same queue. The wheel, up-next strip, and launch flow are unchanged. | ||
| Every draw returns an eight-character seed. On another device with the same library, the same seed and filter produce the same queue. | ||
|
|
||
| ## What your library cost | ||
|
|
||
| Open a game's edit dialog and enter **Price paid** and its **Currency**. Play Insights adds a **What it cost** card: totals by currency, hours played, average cost per hour, and the best-value games. A game's details show its price and its own cost per hour. | ||
| Open a game's edit dialog and enter **Price paid** and its **Currency**. Play Insights adds a **What it cost** card with totals by currency, hours played, average cost per hour, and the best- and worst-value games. A game's details show its price and its own cost per hour. | ||
|
|
||
| - Set the default currency in **Settings > Library**. | ||
| - Bulk Edit can set or clear a price for many games at once. | ||
| - Cost per hour appears only for a priced game with at least a minute of playtime. | ||
| - Totals are grouped by currency. Nothing is converted, and no exchange rate is downloaded. | ||
|
|
||
| Prices and store ids stay on this device for now; they are not carried by library sync. | ||
| Set the default currency in **Settings > Library**. Bulk Edit can set or clear a price for several games at once. A cost per hour appears only for a priced game with at least a minute of playtime. Totals and prices stay on this device and are not carried by library sync, and nothing is converted between currencies. | ||
|
|
||
| ## Notices in your language | ||
|
|
||
| Cloud sync, launch-check changes, rejected emulator-definition packs, and webhook failures now use translated titles and bodies in English, Spanish, German, French, and Portuguese. Notifications saved by older versions keep their English text and still render. | ||
| Cloud sync, launch-check changes, rejected emulator-definition packs, and webhook failures now carry translated titles and bodies in English, Spanish, German, French, and Portuguese. Notifications saved by older versions keep their English text and still render. | ||
|
|
||
| ## Fixed | ||
|
|
||
| - **ScreenScraper lookups returned HTTP 400.** Requests now use the parameter names the API reads (`ssid`, `sspassword`, `softname`, `md5`, `sha1`, `crc`, `romtaille`, and `rom`/`iso`), the Test button calls `ssuserInfos.php`, and refusals sent as plain text are not retried. A ScreenScraper developer ID and password are required and are now documented that way. | ||
|
|
||
| ## Safer by default | ||
|
|
||
| Native storefront discovery is read-only and offline. Provider ids must be digits, install folders must exist, and a GOG executable taken from a game manifest must stay inside its install folder. Commands are argument lists, never a shell. No launcher is modified and no account is used. | ||
|
|
||
| ## Known limits | ||
| - **ScreenScraper lookups returned HTTP 400.** Requests now use the parameter names the API reads (`ssid`, `sspassword`, `softname`, `md5`, `sha1`, `crc`, `romtaille`, and `rom`/`iso`), the Test button calls `ssuserInfos.php`, and refusals sent as plain text are no longer retried. A ScreenScraper developer ID and password are required and are now documented that way. | ||
|
|
||
| - Xbox PC package scanning and owned-but-uninstalled GOG/EA/Ubisoft catalogs are not imported. Native storefront imports are manual; there is no startup auto-import for them. | ||
| - Provider ids, price paid, and Game Night decks are local. They do not cross library sync, and Time Machine does not journal price changes. | ||
| - Cost totals are not converted between currencies. | ||
| - GOG games launch their executable directly, so Galaxy overlay and cloud-save features are not started. | ||
| - Other server responses and some dialog labels remain English. | ||
| - Windows ARM64 and macOS remain out of scope. | ||
| The [changelog](https://github.com/vindeckyy/OpenBoxGL/blob/master/docs/CHANGELOG.md) lists the main areas, not every change. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Restore the still-applicable limitations.
The replacement removes release-relevant caveats from the release-note surface. Users may interpret the release as supporting Xbox and uninstalled catalogs, non-local provider IDs and decks, GOG overlay/cloud saves, untranslated areas, Windows ARM64, and macOS. Restore concise caveats for these limitations instead of stating only that the changelog is incomplete.
Suggested fix
📝 Committable suggestion
🤖 Prompt for AI Agents