diff --git a/wiki-rtd/docs/wiki_images/cemu/cemu-install.png b/wiki-rtd/docs/wiki_images/emulators/cemu/cemu-install.png similarity index 100% rename from wiki-rtd/docs/wiki_images/cemu/cemu-install.png rename to wiki-rtd/docs/wiki_images/emulators/cemu/cemu-install.png diff --git a/wiki-rtd/docs/wiki_images/portmaster/pm-banana.png b/wiki-rtd/docs/wiki_images/systems/portmaster/pm-banana.png similarity index 100% rename from wiki-rtd/docs/wiki_images/portmaster/pm-banana.png rename to wiki-rtd/docs/wiki_images/systems/portmaster/pm-banana.png diff --git a/wiki-rtd/docs/wiki_images/portmaster/pm-boot.png b/wiki-rtd/docs/wiki_images/systems/portmaster/pm-boot.png similarity index 100% rename from wiki-rtd/docs/wiki_images/portmaster/pm-boot.png rename to wiki-rtd/docs/wiki_images/systems/portmaster/pm-boot.png diff --git a/wiki-rtd/docs/wiki_images/portmaster/pm-mainwindow.png b/wiki-rtd/docs/wiki_images/systems/portmaster/pm-mainwindow.png similarity index 100% rename from wiki-rtd/docs/wiki_images/portmaster/pm-mainwindow.png rename to wiki-rtd/docs/wiki_images/systems/portmaster/pm-mainwindow.png diff --git a/wiki-rtd/docs/wiki_images/portmaster/pm-rescan.png b/wiki-rtd/docs/wiki_images/systems/portmaster/pm-rescan.png similarity index 100% rename from wiki-rtd/docs/wiki_images/portmaster/pm-rescan.png rename to wiki-rtd/docs/wiki_images/systems/portmaster/pm-rescan.png diff --git a/wiki-rtd/docs/wiki_images/systems/retroengine/littlemedusa.png b/wiki-rtd/docs/wiki_images/systems/retroengine/littlemedusa.png new file mode 100644 index 0000000..0e45b35 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/systems/retroengine/littlemedusa.png differ diff --git a/wiki-rtd/docs/wiki_images/systems/retroengine/re-appselect.png b/wiki-rtd/docs/wiki_images/systems/retroengine/re-appselect.png new file mode 100644 index 0000000..523cf50 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/systems/retroengine/re-appselect.png differ diff --git a/wiki-rtd/docs/wiki_images/systems/retroengine/re-infolder.png b/wiki-rtd/docs/wiki_images/systems/retroengine/re-infolder.png new file mode 100644 index 0000000..b3ad8b4 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/systems/retroengine/re-infolder.png differ diff --git a/wiki-rtd/docs/wiki_images/systems/retroengine/re-nonedir.png b/wiki-rtd/docs/wiki_images/systems/retroengine/re-nonedir.png new file mode 100644 index 0000000..18c673c Binary files /dev/null and b/wiki-rtd/docs/wiki_images/systems/retroengine/re-nonedir.png differ diff --git a/wiki-rtd/docs/wiki_images/srm/srm-window.png b/wiki-rtd/docs/wiki_images/systems/srm/srm-window.png similarity index 100% rename from wiki-rtd/docs/wiki_images/srm/srm-window.png rename to wiki-rtd/docs/wiki_images/systems/srm/srm-window.png diff --git a/wiki-rtd/docs/wiki_images/srm/sync-config.png b/wiki-rtd/docs/wiki_images/systems/srm/sync-config.png similarity index 100% rename from wiki-rtd/docs/wiki_images/srm/sync-config.png rename to wiki-rtd/docs/wiki_images/systems/srm/sync-config.png diff --git a/wiki-rtd/docs/wiki_images/srm/sync-prompt.png b/wiki-rtd/docs/wiki_images/systems/srm/sync-prompt.png similarity index 100% rename from wiki-rtd/docs/wiki_images/srm/sync-prompt.png rename to wiki-rtd/docs/wiki_images/systems/srm/sync-prompt.png 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 cf022aa..a3ca22a 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 @@ -53,52 +53,26 @@ In doing so we have: - Rebuilt the `pre_build_automation` script was reworked with additional features. - Improved logging. - Implemented changes for the future Godot version of the Configurator. +- RetroDECK Framework can now pick up logged-in Steam profiles for systems like SRM. --- -## Launch with RetroDECK (RetroENGINE) +## RetroENGINE - Run with RetroDECK RetroDECK can be used as an headless engine to run your games. -On the Linux Desktop (or desktop mode), we added the option to open and run various files directly with RetroDECK. +On the Linux Desktop (or desktop mode) we added the option to associate / run / open various games directly with RetroDECK. - +This also comes with the ability to launch the games via CLI. +This is feature is something that have 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). +**Read more here:** - - -### Will RetroENGINE detect what system I want to launch? - -If you have the game file inside the corresponding roms/ folder RetroDECK will understand what system to launch. - -**Example:** - -A `.nes` file is inside the `retrodeck/roms/nes` folder. - -When you click on it, RetroDECK opens it with the Nintendo Entertainment System emulator, and the game starts. - -### What if it is not in the correct folder? - - - -When clicked, RetroDECK will prompt a dialog window asking which system the file belongs to and then run it. - ---- - - -## Launch with games via CLI - -You can also launch games directly via CLI with RetroENGINE. - -Example syntax: - -`flatpak run net.retrodeck.retrodeck retrodeck/roms//` (`--help` for more information). - -This feature have been requested by other developers in the community (or it could be for those Linux Wizard Grognards that only want to use CLI for everything). +[RetroENGINE - Guide](../../wiki_system_guides/retroengine/retroengine-guide.md) --- @@ -145,7 +119,7 @@ One of the goals of PortMaster is to not install or upgrade any existing OS libr **Note:** -That not all 800+ ports are available for the X86_64 system, but the list keeps growing all the time. +That not all 800+ ports are available for the `X86_64` system, but the list keeps growing all the time. **Read more here:** @@ -293,9 +267,9 @@ Added: Experimental N3DS core: Panda3DS. Added: Experimental Playstation 2 core: LRPS2. ``` -### RetroDECK Configurator and Framework +### RetroDECK Configurator - + ``` diff --git a/wiki-rtd/docs/wiki_system_guides/portmaster/portmaster-guide.md b/wiki-rtd/docs/wiki_system_guides/portmaster/portmaster-guide.md index c47818c..8e06a9f 100644 --- a/wiki-rtd/docs/wiki_system_guides/portmaster/portmaster-guide.md +++ b/wiki-rtd/docs/wiki_system_guides/portmaster/portmaster-guide.md @@ -39,7 +39,7 @@ There are two main directories: ## How-to launch PortMaster? - + You go into the PortMaster menu in ES-DE and Open `PortMaster`. @@ -51,7 +51,7 @@ You can also manually update it by going to `Options` -> `Update PortMaster` and ## How-to add games to RetroDECK - + Open `PortMaster` -> `All Ports` and choose the port you want to install (some ports might require additional files). @@ -61,7 +61,7 @@ After you have downloaded the games you want to play exit PortMaster. In the ES-DE Frontend go to the Utilities Menu - + diff --git a/wiki-rtd/docs/wiki_system_guides/retroengine/retroengine-guide.md b/wiki-rtd/docs/wiki_system_guides/retroengine/retroengine-guide.md new file mode 100644 index 0000000..9ca164a --- /dev/null +++ b/wiki-rtd/docs/wiki_system_guides/retroengine/retroengine-guide.md @@ -0,0 +1,58 @@ +# RetroENGINE - Run with RetroDECK + + + +RetroENGINE is how you can run various game files directly with with RetroDECK from the desktop without starting the application. + +It allows association of common system file extensions with RetroDECK. + +Another option is to run the games directly RetroENGINE via CLI. + +This is something that has been requested by the wider development community outside of RetroDECK. + + +## Will RetroENGINE detect what system I want to launch? + +If you have the game file inside the corresponding `retrodeck/roms//` RetroDECK will understand what system to launch. + +### What if it is not in the correct folder? + +When clicked, RetroDECK will prompt a dialog window asking which system the file belongs to and then run it. + +## Launch with games via CLI + +You can also launch games directly with RetroENGINE via CLI. + +**Example syntax:** + +`flatpak run net.retrodeck.retrodeck retrodeck/roms//` (`--help` for more information). + +## Examples: + + + +In these examples, we will use the [Little Medusa - Demo](https://megacatstudios.com/pages/little-medusa) a `.nes` file called `LittleMedusa_8bitdemo.nes` from Mega Cat Studios. + +### Example 1: The Game Inside the Correct Roms Folder + + + +In this example, the `LittleMedusa_8bitdemo.nes` file is inside the `retrodeck/roms/nes` folder. + +When you click on it, RetroDECK opens it with the Nintendo Entertainment System emulator, and the game starts. + +RetroDECK knows that because you opened it from the `/roms/nes` folder, the game must correspond to that system. + +### Example 2: The Game Outside the Roms Folder + + + +In this example, the `LittleMedusa_8bitdemo.nes` file is not inside the `retrodeck/roms/nes` folder but in the `download` folder. + +When clicked, RetroDECK will prompt a dialog window asking which system the file belongs to and then run it. + +### Example 3: Running via CLI + +Example full syntax: + +`flatpak run net.retrodeck.retrodeck retrodeck/roms/nes/LittleMedusa_8bitdemo.nes` 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 91e1c08..f5d82bd 100644 --- a/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md +++ b/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md @@ -22,11 +22,11 @@ We have not added support yet for the Flatpak version of Steam. ## 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. @@ -39,7 +39,7 @@ Depending on your device Steam might need to be restarted before the games show Yes, you can open the entire SRM interface from the Configurator as all other components and tweak to your hearts content. - + ### Help - I broke everything after my tweaking diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index c2a7a6e..b1b9336 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -224,6 +224,9 @@ nav: - Steam Rom Manager 🚂: - SRM - General Guide: wiki_system_guides/srm/srm-guide.md + - RetroENGINE 👨‍🔧: + - RetroENGINE - General Guide: wiki_system_guides/retroengine/retroengine-guide.md + - The Controller Vault 🎮: - Accessibility ♿: