diff --git a/wiki-rtd/docs/wiki_archive/ryujinx/ryujinx-guide.md b/wiki-rtd/docs/wiki_archive/ryujinx/ryujinx-guide.md index 425714b..02ef9f1 100644 --- a/wiki-rtd/docs/wiki_archive/ryujinx/ryujinx-guide.md +++ b/wiki-rtd/docs/wiki_archive/ryujinx/ryujinx-guide.md @@ -4,6 +4,8 @@ **Note: Archived Emulator** +Ryujinx was a Switch emulator. + ## Where to put the games? Switch games should be put into the `retrodeck/roms/switch/` directory. diff --git a/wiki-rtd/docs/wiki_emulator_guides/cemu/cemu-guide.md b/wiki-rtd/docs/wiki_emulator_guides/cemu/cemu-guide.md index 488d3f5..24ec7d0 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/cemu/cemu-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/cemu/cemu-guide.md @@ -2,6 +2,9 @@ <img src="../../../wiki_images/logos/cemu-logo.png" width="150"> +Cemu is a Wii U emulator that is able to run most Wii U games and homebrew. + +--- ### Cemu Links: @@ -13,6 +16,7 @@ [Cemu Webpage](https://cemu.info/) +--- ## Where to put the games? diff --git a/wiki-rtd/docs/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide.md b/wiki-rtd/docs/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide.md index 0cc74e5..bc88361 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide.md @@ -6,6 +6,9 @@ Dolphin feature rich a GameCube and Wii Emulator. Primehack is a fork of Dolphin intended just to give Metroid Prime Trilogy mouselook controls and other improvements. +--- + + ### Dolphin Links: [Dolphin - Webpage](https://dolphin-emu.org/) @@ -27,6 +30,8 @@ Primehack is a fork of Dolphin intended just to give Metroid Prime Trilogy mouse [Primehack - Github](https://github.com/shiiion/dolphin) +--- + ## Where to put the games? diff --git a/wiki-rtd/docs/wiki_emulator_guides/duckstation/duckstation-guide.md b/wiki-rtd/docs/wiki_emulator_guides/duckstation/duckstation-guide.md index 2aa24a8..05d4c66 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/duckstation/duckstation-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/duckstation/duckstation-guide.md @@ -4,6 +4,12 @@ Duckstation is a Playstation 1 - PSX Emulator. +**Note: Legacy Emulator** + +As of RetroDECK 0.9.0b Duckstation have made licensing changes and is marked as Legacy. It will no longer receive any updates and is working as-is. + +--- + ### Duckstation Links: [Duckstation - Webpage](https://www.duckstation.org/) @@ -14,9 +20,8 @@ Duckstation is a Playstation 1 - PSX Emulator. [Duckstation - Github](https://github.com/stenzek/duckstation) -**Note: Legacy Emulator** +--- -As of RetroDECK 0.9.0b Duckstation have made licensing changes and is marked as Legacy. It will no longer receive any updates and is working as-is. ## Where to put the games? diff --git a/wiki-rtd/docs/wiki_emulator_guides/mame/mame-guide.md b/wiki-rtd/docs/wiki_emulator_guides/mame/mame-guide.md index ac31fb6..abbb37d 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/mame/mame-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/mame/mame-guide.md @@ -2,7 +2,13 @@ <img src="../../../wiki_images/logos/mame-logo.png" width="180"> -### melonDS Links: +MAME is a multi-purpose emulation framework. + +MAME’s purpose is to preserve decades of software history. As electronic technology continues to rush forward, MAME prevents this important "vintage" software from being lost and forgotten. + +--- + +### MAME Links: [MAME - Webpage](https://www.mamedev.org/) @@ -12,6 +18,7 @@ [MAME - Documentation](https://docs.mamedev.org/) +--- ## Where to put the games? diff --git a/wiki-rtd/docs/wiki_emulator_guides/melonds/melonds-guide.md b/wiki-rtd/docs/wiki_emulator_guides/melonds/melonds-guide.md index d5cda34..bdf547b 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/melonds/melonds-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/melonds/melonds-guide.md @@ -2,6 +2,10 @@ <img src="../../../wiki_images/logos/melonds-logo.svg" width="150"> +melonDS, a Nintendo DS emulator. + +--- + ### melonDS Links: [melonDS - Webpage](https://melonds.kuribo64.net/) @@ -14,6 +18,8 @@ [melonDS - Github](https://github.com/melonDS-emu/melonDS) +--- + ## Where to put the games NDS games should be put under the `retrodeck/roms/nds/` directory. diff --git a/wiki-rtd/docs/wiki_emulator_guides/pcsx2/pcsx2-guide.md b/wiki-rtd/docs/wiki_emulator_guides/pcsx2/pcsx2-guide.md index dad9de4..cc48e09 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/pcsx2/pcsx2-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/pcsx2/pcsx2-guide.md @@ -2,6 +2,10 @@ <img src="../../../wiki_images/logos/pcsx2-logo.png" width="180"> +PCSX2 is a free and open-source PlayStation 2 (PS2) emulator. + +--- + ### PCSX2 Links: [PCSX2 Documentation](https://pcsx2.net/docs/) @@ -12,6 +16,8 @@ [PCSX2 Compability List](https://pcsx2.net/compat/) +--- + ## Where to put the games Playstation 2 games should be put under the `retrodeck/roms/ps2/` directory. diff --git a/wiki-rtd/docs/wiki_emulator_guides/ppsspp/ppsspp-guide.md b/wiki-rtd/docs/wiki_emulator_guides/ppsspp/ppsspp-guide.md index 1d4d518..9317b61 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/ppsspp/ppsspp-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/ppsspp/ppsspp-guide.md @@ -2,6 +2,10 @@ <img src="../../../wiki_images/logos/ppsspp-logo.png" width="150"> +A PSP emulator that can also upscale textures to make them sharper, and you can enable post-processing shaders to adjust color and brightness the way you like, and other effects. + +--- + ### PPSSPP Links: [PPSSPP - Webpage](https://www.ppsspp.org/) @@ -18,6 +22,8 @@ [PPSSPP - Github](https://github.com/hrydgard/ppsspp) +--- + ## Where to put the games? PSP games should be put under the `retrodeck/roms/psp/` directory. diff --git a/wiki-rtd/docs/wiki_emulator_guides/retroarch/retroarch-guide.md b/wiki-rtd/docs/wiki_emulator_guides/retroarch/retroarch-guide.md index fde6e46..ad50e52 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/retroarch/retroarch-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/retroarch/retroarch-guide.md @@ -4,7 +4,7 @@ RetroArch is a multi-emulator that play games with emulator cores. -RetroDECK ships all available cores from the stable branch and if no stable core exist RetroDECK will take the latest Beta version of the core. +--- ### RetroArch Links @@ -16,6 +16,7 @@ RetroDECK ships all available cores from the stable branch and if no stable core [ES-DE User Guide: Supported Game Systems](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#supported-game-systems) + ### RetroArch Docs - Guide Links Here follows various quick bookmarks to specific section of the RetroArch Docs that is good to read and always updated with the lastest information. @@ -30,6 +31,9 @@ Here follows various quick bookmarks to specific section of the RetroArch Docs t [RetroArch - Shaders Guide](https://docs.libretro.com/guides/shaders/) +--- + + ## Where to put the games? RetroArch supports a multiple of systems under: diff --git a/wiki-rtd/docs/wiki_emulator_guides/rpcs3/rpcs3-guide.md b/wiki-rtd/docs/wiki_emulator_guides/rpcs3/rpcs3-guide.md index 2fa7428..c9df79a 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/rpcs3/rpcs3-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/rpcs3/rpcs3-guide.md @@ -2,6 +2,8 @@ <img src="../../../wiki_images/logos/rpcs3-logo.png" width="150"> +RPCS3 is a multi-platform open-source Sony PlayStation 3 emulator and debugger. + --- ### RPCS3 Links: diff --git a/wiki-rtd/docs/wiki_emulator_guides/ruffle/ruffle-guide.md b/wiki-rtd/docs/wiki_emulator_guides/ruffle/ruffle-guide.md index b0c2ddd..c9b0ff6 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/ruffle/ruffle-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/ruffle/ruffle-guide.md @@ -2,7 +2,7 @@ <img src="../../../wiki_images/logos/ruffle-logo.svg" width="150"> -An open source Flash Player emulator +An open source Flash Player emulator. **Note:** diff --git a/wiki-rtd/docs/wiki_emulator_guides/vita3k/vita3k-guide.md b/wiki-rtd/docs/wiki_emulator_guides/vita3k/vita3k-guide.md index a459e5c..3ccd8d2 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/vita3k/vita3k-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/vita3k/vita3k-guide.md @@ -2,6 +2,8 @@ <img src="../../../wiki_images/logos/vita3k-logo.png" width="150"> +Vita3K is an experimental open-source Sony PlayStation Vita emulator. + --- ### Vita3K Links: diff --git a/wiki-rtd/docs/wiki_emulator_guides/xemu/xemu-guide.md b/wiki-rtd/docs/wiki_emulator_guides/xemu/xemu-guide.md index 36408f3..7e54d7f 100644 --- a/wiki-rtd/docs/wiki_emulator_guides/xemu/xemu-guide.md +++ b/wiki-rtd/docs/wiki_emulator_guides/xemu/xemu-guide.md @@ -2,6 +2,10 @@ <img src="../../../wiki_images/logos/xemu-logo.png" width="150"> +A free and open-source application that emulates the original Microsoft Xbox game console. + +--- + ### xemu Links: [xemu Compatibility Guide](https://xemu.app/#compatibility) @@ -12,6 +16,7 @@ [xemu Webpage](https://xemu.app/) +--- ## Where to put the games Xbox games should be put under the `retrodeck/roms/xbox/` directory. diff --git a/wiki-rtd/docs/wiki_engine_guides/gzdoom/gzdoom-guide.md b/wiki-rtd/docs/wiki_engine_guides/gzdoom/gzdoom-guide.md index a5e9282..4dc637a 100644 --- a/wiki-rtd/docs/wiki_engine_guides/gzdoom/gzdoom-guide.md +++ b/wiki-rtd/docs/wiki_engine_guides/gzdoom/gzdoom-guide.md @@ -4,6 +4,8 @@ GZDoom is the open source game engine for ID Software's older games like DOOM, DOOM2, HEXEN and HERETIC or it's own unique games. +--- + ### GZDoom Links: [ZDoom Web Page](https://zdoom.org/index) @@ -12,15 +14,9 @@ GZDoom is the open source game engine for ID Software's older games like DOOM, D [ZDoom Forums](https://forum.zdoom.org/) -### Freedoom +--- -The Freedoom project aims to provide all the content needed to form a complete, entirely free/libre game for the Doom engine. - -It is designed to be compatible with most custom levels, music, graphics and other modifications (“mods”) made for the original Doom games by Doom fans and artists over the decades. - -[FreeDOOM](https://freedoom.github.io/) - -### Where to buy official DOOM? +## Where to buy official DOOM? You will need `DOOM + DOOM II`. @@ -40,6 +36,14 @@ The games `DOOM 3` and `DOOM 64` are not needed but we list them here because it - [DOOM 3 - Steam](https://store.steampowered.com/app/208200/DOOM_3/) +### Freedoom + +The Freedoom project aims to provide all the content needed to form a complete, entirely free/libre game for the Doom engine. + +It is designed to be compatible with most custom levels, music, graphics and other modifications (“mods”) made for the original Doom games by Doom fans and artists over the decades. + +[FreeDOOM](https://freedoom.github.io/) + ## What are iwads gzdoom is looking for? The [IWADS](https://doomwiki.org/wiki/IWAD) Gzdoom is looking for to be able to run are the following: diff --git a/wiki-rtd/docs/wiki_engine_guides/ikemengo/ikemengo-guide.md b/wiki-rtd/docs/wiki_engine_guides/ikemengo/ikemengo-guide.md index 2027e62..ad095d8 100644 --- a/wiki-rtd/docs/wiki_engine_guides/ikemengo/ikemengo-guide.md +++ b/wiki-rtd/docs/wiki_engine_guides/ikemengo/ikemengo-guide.md @@ -6,6 +6,7 @@ It strives to be compatible with games made for those engines. +--- ### IkemanGO Links: @@ -15,6 +16,7 @@ It strives to be compatible with games made for those engines. [IkemanGO Webpage](https://ikemen-engine.github.io/) +--- ## Where to put the games diff --git a/wiki-rtd/docs/wiki_engine_guides/openbor/openbor-guide.md b/wiki-rtd/docs/wiki_engine_guides/openbor/openbor-guide.md index 1ec6903..9f28ca7 100644 --- a/wiki-rtd/docs/wiki_engine_guides/openbor/openbor-guide.md +++ b/wiki-rtd/docs/wiki_engine_guides/openbor/openbor-guide.md @@ -2,13 +2,9 @@ <img src="../../../wiki_images/logos//openbor-logo.svg" width="150"> -Open Beats of Rage or `OpenBOR` is a beat 'em up game engine and Chronocrash is the main community of OpenBOR. +Open Beats of Rage or `OpenBOR` is a beat 'em up game engine. -## Notice: OPENBOR IS BROKEN - -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. - -Sorry Beat 'em up fans, you will have to wait for the fix. +--- ### OpenBOR Links: @@ -22,7 +18,7 @@ Sorry Beat 'em up fans, you will have to wait for the fix. [Chronocrash Forum](https://www.chronocrash.com/forum/) - +--- ## Where to put the games OpenBOR games should be put under the `retrodeck/roms/openbor/` directory. diff --git a/wiki-rtd/docs/wiki_engine_guides/pico8/pico8-guide.md b/wiki-rtd/docs/wiki_engine_guides/pico8/pico8-guide.md index d70c1a7..ab5e06b 100644 --- a/wiki-rtd/docs/wiki_engine_guides/pico8/pico8-guide.md +++ b/wiki-rtd/docs/wiki_engine_guides/pico8/pico8-guide.md @@ -4,7 +4,9 @@ PICO-8 Fantasy Console is a game engine developed by Lexaloffle Games that you need to buy a license to use. -### Cemu Links: +--- + +### Pico-8 Links: [Pico-8 FAQ](https://www.lexaloffle.com/pico-8.php?page=faq) @@ -14,6 +16,8 @@ PICO-8 Fantasy Console is a game engine developed by Lexaloffle Games that you n [Itch.io - Pico-8](https://lexaloffle.itch.io/pico-8) +--- + ## Where to put the games? PICO-8 games should be put under the `retrodeck/roms/pico8/` directory. diff --git a/wiki-rtd/docs/wiki_engine_guides/scummvm/scummvm-guide.md b/wiki-rtd/docs/wiki_engine_guides/scummvm/scummvm-guide.md index 5d3cc53..4d7922b 100644 --- a/wiki-rtd/docs/wiki_engine_guides/scummvm/scummvm-guide.md +++ b/wiki-rtd/docs/wiki_engine_guides/scummvm/scummvm-guide.md @@ -2,11 +2,13 @@ <img src="../../../wiki_images/logos/scummvm-logo.svg" width="150"> -This guide works for both the `ScummVM RetroArch Core` and `ScummVM-SA` +ScummVM is a engine which allows you to run certain classic graphical adventure and role-playing games. **Note:** -`ScummVM-SA` is not implemented in RetroDECK yet. But will be available in a future version. +`ScummVM-SA` is not implemented in RetroDECK yet. But will be available in a future version, only the `ScummVM RetroArch Core` exists for now. + +--- ### ScummVM Links: @@ -20,6 +22,7 @@ This guide works for both the `ScummVM RetroArch Core` and `ScummVM-SA` [ScummVM Webpage](https://www.scummvm.org/) +--- ### Where to put the games? @@ -45,6 +48,8 @@ No ## How-to: Create .scummvm files that run in ES-DE +This guide works for both the `ScummVM-SA` and `ScummVM RetroArch Core`. + **Example:** In this example we got a game we want to add: `Beneath a Steel Sky` diff --git a/wiki-rtd/docs/wiki_engine_guides/solarus/solarus-guide.md b/wiki-rtd/docs/wiki_engine_guides/solarus/solarus-guide.md index 57d11fb..80c9cc4 100644 --- a/wiki-rtd/docs/wiki_engine_guides/solarus/solarus-guide.md +++ b/wiki-rtd/docs/wiki_engine_guides/solarus/solarus-guide.md @@ -4,6 +4,9 @@ Solarus is an open-source adventure game engine. +--- + + ### Solarus Links: [Solarus Community](https://www.solarus-games.org/community/) @@ -14,6 +17,9 @@ Solarus is an open-source adventure game engine. [Solarus Web page](https://www.solarus-games.org/) +--- + + ## Where to put the games? Solarus games should be put under the `retrodeck/roms/solarus/` directory. diff --git a/wiki-rtd/docs/wiki_system_guides/es-de/esde-guide.md b/wiki-rtd/docs/wiki_system_guides/es-de/esde-guide.md index dfb06f0..9747d06 100644 --- a/wiki-rtd/docs/wiki_system_guides/es-de/esde-guide.md +++ b/wiki-rtd/docs/wiki_system_guides/es-de/esde-guide.md @@ -1,8 +1,15 @@ -# ES-DE: General Guide +# ES-DE Frontend: General Guide <img src="../../../wiki_images/logos/es-de-logo.png" width="150"> -ES-DE is RetroDECK's primary frontend. +ES-DE Frontend (EmulationStation Desktop Edition) is a frontend for browsing and launching games from your multi-platform collection. + +**Note:** + +ES-DE is the default frontend used in RetroDECK. + +--- + ### ES-DE Links: @@ -20,6 +27,9 @@ ES-DE is RetroDECK's primary frontend. [ES-DE Development: Roadmap](https://gitlab.com/es-de/emulationstation-de/-/blob/master/ROADMAP.md) +--- + + ## Folder structure | Type | Folder | Comment | 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 90b68d2..a20eebb 100755 --- a/wiki-rtd/docs/wiki_system_guides/portmaster/portmaster-guide.md +++ b/wiki-rtd/docs/wiki_system_guides/portmaster/portmaster-guide.md @@ -6,8 +6,11 @@ PortMaster is a simple GUI tool designed to facilitate the downloading and insta One of the goals of PortMaster is to not install or upgrade any existing OS libraries for any ports. Any of the ports that need a particular non-standard library are maintained within the ports' folder and made available specifically to that port during execution. +**Note:** + Not all ports are available for the `X86_64` system, but the list is continuously growing. +--- ### PortMaster Links: @@ -19,6 +22,8 @@ Not all ports are available for the `X86_64` system, but the list is continuousl [PortMaster FAQ](https://portmaster.games/faq.html) +--- + ### Does PortMaster require BIOS / Firmware / Other files? PortMaster does not require BIOS or Firmware but depending on the game you might need to supply the official game files from purchased titles to get them to run. 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 31237ae..b318a92 100644 --- a/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md +++ b/wiki-rtd/docs/wiki_system_guides/srm/srm-guide.md @@ -6,9 +6,11 @@ Steam ROM Manager is a tool that helps you import games in bulk and manage artwo This tool adds individual games to Steam, incorporates artwork from [SteamGridDB](https://www.steamgriddb.com/), and configures the RetroDECK Steam Input layouts. -Additionally, RetroDECK uses Steam ROM Manager as part of its backend for the Steam Sync feature. +**Note:** +Additionally, RetroDECK uses Steam ROM Manager as part of its backend for the `Steam Sync` feature that is documented here. +--- ### SRM Links: @@ -18,6 +20,8 @@ Additionally, RetroDECK uses Steam ROM Manager as part of its backend for the St [SteamGridDB](https://www.steamgriddb.com/) +--- + ### Warning - Flatpak Steam not yet supported We haven't added support for the Flatpak version of Steam yet. @@ -145,4 +149,4 @@ There are two types of launch commands in the script: The second command is for future Steam Flatpak support, as it requires the flatpak-spawn permission to launch the games and must be manually enabled by the user. -Currently, games are not added to Flatpak Steam via Steam Sync. \ No newline at end of file +Currently, games are not added to Flatpak Steam via Steam Sync.