diff --git a/wiki-rtd/docs/wiki_about/what-is-included.md b/wiki-rtd/docs/wiki_about/what-is-included.md index 925f6d9..6fed53f 100644 --- a/wiki-rtd/docs/wiki_about/what-is-included.md +++ b/wiki-rtd/docs/wiki_about/what-is-included.md @@ -4,6 +4,7 @@ What follows is a list of features and software currently included in RetroDECK. +NOTE THIS IS BEING UPDATED FOR AN UPCOMING UPDATE AND MIGHT NOT REFLECT CURRENT STABLE ### Note: RetroDECK does not include any games, proprietary BIOS or Firmware diff --git a/wiki-rtd/docs/wiki_rd_versions/version_0.9.0b/0.9.0b.md b/wiki-rtd/docs/wiki_rd_versions/version_0.9.0b/0.9.0b.md index 01dabc0..d38854f 100644 --- a/wiki-rtd/docs/wiki_rd_versions/version_0.9.0b/0.9.0b.md +++ b/wiki-rtd/docs/wiki_rd_versions/version_0.9.0b/0.9.0b.md @@ -121,13 +121,13 @@ We have not added support yet for the Flatpak version of Steam. Steam ROM Manager a bulk game importer and artwork manager for Steam. -It adds separate games to Steam, adds artwork and configures the steam input profiles. +It adds separate games to Steam, adds artwork from [SteamGridDB](https://www.steamgriddb.com/) and configures the RetroDECK Steam Input layouts. ### How does it work in RetroDECK? You enable the Steam Sync feature inside the configurator. -All the games you have marked as favorites in ES-DE ( marked with a ⭐) will be Synced to Steam upon application exist with art. +All the games you have marked as favorites in ES-DE (marked with a ⭐) will be Synced to Steam upon application exist with art. Depending on your device Steam might need to be restarted before the games show up. diff --git a/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md b/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md index 15c43a7..bafc168 100644 --- a/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md +++ b/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md @@ -2,94 +2,32 @@ -Open Beats of Rage or `OpenBOR` is a beat 'em up game engine and Chronocrash is the main community of OpenBOR. +Steam ROM Manager a bulk game importer and artwork manager for Steam. -## Notice: OPENBOR IS BROKEN +It adds separate games to Steam, adds artwork from SteamGridDB and configures the RetroDECK Steam Input layouts. -The current standard OpenBOR solution is not working as well as we hoped. We are going redesign the implementation and ship it in a upcomming update. +RetroDECK uses it as part of it's backend for the Steam Sync feature. -Sorry Beat 'em up fans, you will have to wait for the fix. +**Notice: Flatpak Steam not yet supported** -### OpenBOR Links: +We have not added support yet for the Flatpak version of Steam. -[OpenBOR Github](https://github.com/DCurrent/openbor) +### SRM Links: -[OpenBOR Wiki](https://github.com/DCurrent/openbor/wiki) +[Steam Rom Manager - Webpage](https://steamgriddb.github.io/steam-rom-manager/) -[Chronocrash Community](https://www.chronocrash.com/) +[Steam Rom Manager - Github](https://github.com/SteamGridDB/steam-rom-manager) -[Chronocrash Wiki](https://chronocrash.com/obor/wiki/) +[SteamGridDB](https://www.steamgriddb.com/) -[Chronocrash Forum](https://www.chronocrash.com/forum/) +### How-to enable Steam Sync? +You can enable the Steam Sync feature inside the Configurator. +All the games you have marked as favorites in ES-DE (marked with a ⭐) will be Synced to Steam upon application exist with art. -## Where to put the games -OpenBOR games should be put under the `retrodeck/roms/openbor/` directory. +Depending on your device Steam might need to be restarted before the games show up. -## Does OpenBOR require BIOS or Firmware? -No +### Can I tweak images or other settings in SRM? -## What file formats are supported? - -`.AppImage ` - -### Information - -- The games need to be uncompressed to a folder. -- Each game is its own self-contained game, and no overarching settings exist. - -### Example folder structure of a OpenBOR game - -A fake fan game called `Heroes of Phandalin` - -``` -~/retrodeck/roms/openbor/Heroes of Phandalin.AppImage/ -~/retrodeck/roms/openbor/Heroes of Phandalin.AppImage/Logs/ -~/retrodeck/roms/openbor/Heroes of Phandalin.AppImage/Paks/ -~/retrodeck/roms/openbor/Heroes of Phandalin.AppImage/Saves/ -~/retrodeck/roms/openbor/Heroes of Phandalin.AppImage/ScreenShots/ -~/retrodeck/roms/openbor/Heroes of Phandalin.AppImage/Heroes of Phandalin.AppImage -``` - -## OpenBOR How-to add a game - -- Extract the game if it is compressed into a new folder under `roms/openbor/`. -- Rename the folder so it is called `.AppImage` in the end of it. -- Open the game folder and see if the `OpenBOR-Linux-x64-.AppImage` file is there in the root of the folder. -- If the file is there rename it to `.AppImage`. - -The game should now be detected and runnable from RetroDECK. - -### Example on renaming: - -If the game is called Heroes of Phandalin rename the `OpenBOR-Linux-x64-.AppImage` file & the games folder to `Heroes of Phandalin.AppImage` - -``` -~/retrodeck/roms/openbor/Heroes of Phandalin.AppImage/Heroes of Phandalin.AppImage -``` - -The `Heroes of Phandalin.AppImage` file exists within the `Heroes of Phandalin.AppImage` folder. - -### OpenBOR.AppImage is missing: - -If the `OpenBOR-Linux-x64-.AppImage` is missing from the games folder you will need to download it from [OpenBOR Github](https://github.com/DCurrent/openbor) releases page and add it to the game folder. - -Copy the file the games folder and rename it as stated above then make it executable. - -**NOTE: On compatibly**
-Some games might only be compatible with certain version of OpenBOR. Try the latest version first and if that does not work check the games folder for clues on what version it was made for and download the correct .AppImage version from [OpenBOR Github](https://github.com/DCurrent/openbor) releases page. - -#### Make the file executable - -**Using the terminal:** - -``` -chmod +x OpenBOR-Linux-x64-.AppImage -``` - -**Using the Systems GUI** - -This example is from KDE: - -Right Click on `OpenBOR-Linux-x64-.AppImage` -> Properties -> Permissions -> Check the `Is executable` checkbox. +Yes, you can open the entire SRM interface from the Configurator as all other components and tweak to your hearts content.