diff --git a/wiki-rtd/docs/wiki_engine_guides/gzdoom/retrodeck-doomfile.md b/wiki-rtd/docs/wiki_engine_guides/gzdoom/retrodeck-doomfile.md index 96c01d4..f5d0d43 100644 --- a/wiki-rtd/docs/wiki_engine_guides/gzdoom/retrodeck-doomfile.md +++ b/wiki-rtd/docs/wiki_engine_guides/gzdoom/retrodeck-doomfile.md @@ -82,21 +82,6 @@ But this can be different, check the where you download the mods if they have an RetroDECK have written a new parser from the ground up. You no longer need to write the path in the .doom files. RetroDECK scans all folders and subfolders of `/roms/doom/` only put the name of the mod file. If you are migrating to RetroDECK all you need to do is remove the path in your .doom files. -## SteamGridDB - Grid and Tear Project - - - - -[SteamGridDB: Grid and Tear](https://www.steamgriddb.com/projects/grid-and-tear) - - -If you plan to use RetroDECK's built-in `Steam Sync` function for `.doom` files to add them to Steam as seperate games. - -You need to match the names of the `.doom` files with how they are called on `SteamGridDB` for the art to be correctly scraped. - -Use the the link above to search for what mods are supported currently with art. - -[Example - SteamGridDB: Project Brutality](https://www.steamgriddb.com/game/5320302) ## Project Brutality .doom example: @@ -186,4 +171,13 @@ Maybe you have found the perfect combination of over 50 + mods in one `.doom` fi Share the `.doom` file and where to download the mods with the RetroDECK Community! +## Adding .doom files to Steam as seperate games + + + +You can use the built in `Steam Sync` function to add .doom files as seperate games in Steam with art. + +**Check the:** + +[SRM Guide](../../wiki_system_guides/srm/srm-guide.md) for more information. diff --git a/wiki-rtd/docs/wiki_images/systems/srm/brutaldoom.png b/wiki-rtd/docs/wiki_images/systems/srm/brutaldoom.png new file mode 100644 index 0000000..497da45 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/systems/srm/brutaldoom.png differ diff --git a/wiki-rtd/docs/wiki_images/systems/srm/es-de-favorite.png b/wiki-rtd/docs/wiki_images/systems/srm/es-de-favorite.png new file mode 100644 index 0000000..b0e394b Binary files /dev/null and b/wiki-rtd/docs/wiki_images/systems/srm/es-de-favorite.png differ diff --git a/wiki-rtd/docs/wiki_images/systems/srm/sync-loading.png b/wiki-rtd/docs/wiki_images/systems/srm/sync-loading.png new file mode 100644 index 0000000..e9ac314 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/systems/srm/sync-loading.png differ 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 67f99c2..3188c30 100755 --- 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 @@ -71,6 +71,8 @@ This also includes the ability to launch games via the CLI. This feature has been requested by the wider development community outside of RetroDECK (and maybe a few Linux Wizard Grognards that only want to use CLI for everything). +We can't wait to see what other developers do with it. + **Quote from Discord User:** *"Whoa! That is a lot of text for saying you can now double click on game files and they open"* 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 db71b59..187dcf6 100755 --- a/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md +++ b/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md @@ -6,11 +6,7 @@ Steam ROM Manager is a bulk game importer and artwork manager for Steam. It has It adds separate games to Steam, incorporates artwork from [SteamGridDB](https://www.steamgriddb.com/) , and configures the RetroDECK Steam Input layouts. -RetroDECK uses Steam ROM Manager as part of its backend for the Steam Sync feature. - -**Notice: Flatpak Steam Not Yet Supported** - -We have not yet added support for the Flatpak version of Steam. +RetroDECK uses Steam ROM Manager as part of its backend for the `Steam Sync` feature. ### SRM Links: @@ -20,6 +16,20 @@ We have not yet added support for the Flatpak version of Steam. [SteamGridDB](https://www.steamgriddb.com/) +### Warning - Flatpak Steam not yet supported + +We have not yet added support for the Flatpak version of Steam. + +### Warning - Exotic ROMS filenames can break the scripts + +Some games have exotic symbols in their name that could break so the parser and the game won't launch, `( ) [ ]` are fine. + +The symbols that could cause issues are: + +/ \ { } < > ' * ` + +It might be worth to rename those games if it contains them. + ## Folder structure | Type | Folder | Comment | @@ -29,15 +39,43 @@ We have not yet added support for the Flatpak version of Steam. ## How-to enable Steam Sync? - +All the games you have marked as favorites in ES-DE (marked with a ⭐ or another icon depending on theme) will be synced to Steam upon exiting the application, along with their artwork and will show up after Steam is restarted. -You can enable the Steam Sync feature inside the Configurator. +### Mark games as ⭐ favorites in ES-DE + + + +Navigate to a game in ES-DE and press the press the `north button` to mark a game as favorite in ES-DE (Xbox `Y` button, Playstation `Triangle`, Nintendo `X`). + +### Enable in Configurator + + -All the games you have marked as favorites in ES-DE (marked with a ⭐) will be synced to Steam upon exiting the application, along with their artwork. -Depending on your device, Steam might need to be restarted before the games show up in your library. +Enable the Steam Sync feature inside the Configurator by pressing `Yes`. + +### Exit RetroDECK to start the Sync + + + +**Note:** If you have a massive roms library this can take a while. But you can leave the sync window in the background and play other things while it runs. The speed also depends on the Device you are using. + +Just wait until the Sync is finished and the window closes. + + +### Restart / Reload Steam + +Steam needs to be restarted before the games show up in your library. + +For the Steam Deck you can either restart the Steam Deck or from `Game Mode` enter `Desktop Mode` and directly go back to `Game Mode` as this will also relaunch Steam. + +If you are on a PC just `Exit Steam` and relaunch it as normal. + +## How do I disable Steam Sync? + +Just go into the Configurator and press Steam Sync if you got it enabled it will now ask if you want to disable it. Just press `Yes` in the prompt. ## Can I tweak images or other settings in SRM? @@ -47,13 +85,32 @@ Yes, you can open the entire SRM interface from the Configurator, just like all - ### Help - I broke everything after my tweaking If you break things you could always reset it to default via: `Configurator` -> `Troubleshooting` -> `Reset` -> `Component` -> `Steam Rom Manager`. +## Adding RetroDECK .doom files to Steam - Grid and Tear Project + + + +[SteamGridDB: Grid and Tear](https://www.steamgriddb.com/projects/grid-and-tear) is a project for adding art for various doom mods. + +They work with RetroDECK's `.doom` files. + +[Guide: RetroDECK .doom file](../../wiki_engine_guides/gzdoom/retrodeck-doomfile.md) + +### How-to add .doom files with art? + +You need to match the names of the `.doom` files with how they are called on `SteamGridDB` for the art to be correctly scraped. + +Use the the link above to search for what mods are supported currently with art. + +[Example - SteamGridDB: Brutal DOOM](https://www.steamgriddb.com/game/5249817) + +The file in this case is called `Brutal Doom.doom`. + ## How does it work? When the sync function is activated launch scripts are generated in a hidden folder: @@ -71,13 +128,3 @@ This is the regular launch command This one is for future Steam Flatpak support, as they need the `flatpak-spawn` permission to launch the games and have to be manually enabled by the user. Currently the games are not added to Flatpak Steam via Steam Sync. - -## Warning - Exotic ROMS filenames can break the scripts - -Some games have exotic symbols in their name that could break so the parser and the game won't launch, `( ) [ ]` are fine. - -The symbols that could cause issues are: - -/ \ { } < > ' * ` - -It might be worth to rename those games if it contains them.