This commit is contained in:
laz 2025-01-24 12:59:33 +01:00
parent 3e8e76a0bb
commit c7661dfa00
22 changed files with 117 additions and 27 deletions
wiki-rtd/docs

View file

@ -4,6 +4,8 @@
**Note: Archived Emulator** **Note: Archived Emulator**
Ryujinx was a Switch emulator.
## Where to put the games? ## Where to put the games?
Switch games should be put into the `retrodeck/roms/switch/` directory. Switch games should be put into the `retrodeck/roms/switch/` directory.

View file

@ -2,6 +2,9 @@
<img src="../../../wiki_images/logos/cemu-logo.png" width="150"> <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: ### Cemu Links:
@ -13,6 +16,7 @@
[Cemu Webpage](https://cemu.info/) [Cemu Webpage](https://cemu.info/)
---
## Where to put the games? ## Where to put the games?

View file

@ -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. Primehack is a fork of Dolphin intended just to give Metroid Prime Trilogy mouselook controls and other improvements.
---
### Dolphin Links: ### Dolphin Links:
[Dolphin - Webpage](https://dolphin-emu.org/) [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) [Primehack - Github](https://github.com/shiiion/dolphin)
---
## Where to put the games? ## Where to put the games?

View file

@ -4,6 +4,12 @@
Duckstation is a Playstation 1 - PSX Emulator. 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 Links:
[Duckstation - Webpage](https://www.duckstation.org/) [Duckstation - Webpage](https://www.duckstation.org/)
@ -14,9 +20,8 @@ Duckstation is a Playstation 1 - PSX Emulator.
[Duckstation - Github](https://github.com/stenzek/duckstation) [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? ## Where to put the games?

View file

@ -2,7 +2,13 @@
<img src="../../../wiki_images/logos/mame-logo.png" width="180"> <img src="../../../wiki_images/logos/mame-logo.png" width="180">
### melonDS Links: MAME is a multi-purpose emulation framework.
MAMEs 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/) [MAME - Webpage](https://www.mamedev.org/)
@ -12,6 +18,7 @@
[MAME - Documentation](https://docs.mamedev.org/) [MAME - Documentation](https://docs.mamedev.org/)
---
## Where to put the games? ## Where to put the games?

View file

@ -2,6 +2,10 @@
<img src="../../../wiki_images/logos/melonds-logo.svg" width="150"> <img src="../../../wiki_images/logos/melonds-logo.svg" width="150">
melonDS, a Nintendo DS emulator.
---
### melonDS Links: ### melonDS Links:
[melonDS - Webpage](https://melonds.kuribo64.net/) [melonDS - Webpage](https://melonds.kuribo64.net/)
@ -14,6 +18,8 @@
[melonDS - Github](https://github.com/melonDS-emu/melonDS) [melonDS - Github](https://github.com/melonDS-emu/melonDS)
---
## Where to put the games ## Where to put the games
NDS games should be put under the `retrodeck/roms/nds/` directory. NDS games should be put under the `retrodeck/roms/nds/` directory.

View file

@ -2,6 +2,10 @@
<img src="../../../wiki_images/logos/pcsx2-logo.png" width="180"> <img src="../../../wiki_images/logos/pcsx2-logo.png" width="180">
PCSX2 is a free and open-source PlayStation 2 (PS2) emulator.
---
### PCSX2 Links: ### PCSX2 Links:
[PCSX2 Documentation](https://pcsx2.net/docs/) [PCSX2 Documentation](https://pcsx2.net/docs/)
@ -12,6 +16,8 @@
[PCSX2 Compability List](https://pcsx2.net/compat/) [PCSX2 Compability List](https://pcsx2.net/compat/)
---
## Where to put the games ## Where to put the games
Playstation 2 games should be put under the `retrodeck/roms/ps2/` directory. Playstation 2 games should be put under the `retrodeck/roms/ps2/` directory.

View file

@ -2,6 +2,10 @@
<img src="../../../wiki_images/logos/ppsspp-logo.png" width="150"> <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 Links:
[PPSSPP - Webpage](https://www.ppsspp.org/) [PPSSPP - Webpage](https://www.ppsspp.org/)
@ -18,6 +22,8 @@
[PPSSPP - Github](https://github.com/hrydgard/ppsspp) [PPSSPP - Github](https://github.com/hrydgard/ppsspp)
---
## Where to put the games? ## Where to put the games?
PSP games should be put under the `retrodeck/roms/psp/` directory. PSP games should be put under the `retrodeck/roms/psp/` directory.

View file

@ -4,7 +4,7 @@
RetroArch is a multi-emulator that play games with emulator cores. 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 ### 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) [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 ### 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. 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/) [RetroArch - Shaders Guide](https://docs.libretro.com/guides/shaders/)
---
## Where to put the games? ## Where to put the games?
RetroArch supports a multiple of systems under: RetroArch supports a multiple of systems under:

View file

@ -2,6 +2,8 @@
<img src="../../../wiki_images/logos/rpcs3-logo.png" width="150"> <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: ### RPCS3 Links:

View file

@ -2,7 +2,7 @@
<img src="../../../wiki_images/logos/ruffle-logo.svg" width="150"> <img src="../../../wiki_images/logos/ruffle-logo.svg" width="150">
An open source Flash Player emulator An open source Flash Player emulator.
**Note:** **Note:**

View file

@ -2,6 +2,8 @@
<img src="../../../wiki_images/logos/vita3k-logo.png" width="150"> <img src="../../../wiki_images/logos/vita3k-logo.png" width="150">
Vita3K is an experimental open-source Sony PlayStation Vita emulator.
--- ---
### Vita3K Links: ### Vita3K Links:

View file

@ -2,6 +2,10 @@
<img src="../../../wiki_images/logos/xemu-logo.png" width="150"> <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 Links:
[xemu Compatibility Guide](https://xemu.app/#compatibility) [xemu Compatibility Guide](https://xemu.app/#compatibility)
@ -12,6 +16,7 @@
[xemu Webpage](https://xemu.app/) [xemu Webpage](https://xemu.app/)
---
## Where to put the games ## Where to put the games
Xbox games should be put under the `retrodeck/roms/xbox/` directory. Xbox games should be put under the `retrodeck/roms/xbox/` directory.

View file

@ -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 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: ### GZDoom Links:
[ZDoom Web Page](https://zdoom.org/index) [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/) [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. ## Where to buy official DOOM?
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?
You will need `DOOM + DOOM II`. 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/) - [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? ## 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: The [IWADS](https://doomwiki.org/wiki/IWAD) Gzdoom is looking for to be able to run are the following:

View file

@ -6,6 +6,7 @@
It strives to be compatible with games made for those engines. It strives to be compatible with games made for those engines.
---
### IkemanGO Links: ### IkemanGO Links:
@ -15,6 +16,7 @@ It strives to be compatible with games made for those engines.
[IkemanGO Webpage](https://ikemen-engine.github.io/) [IkemanGO Webpage](https://ikemen-engine.github.io/)
---
## Where to put the games ## Where to put the games

View file

@ -2,13 +2,9 @@
<img src="../../../wiki_images/logos//openbor-logo.svg" width="150"> <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: ### 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/) [Chronocrash Forum](https://www.chronocrash.com/forum/)
---
## Where to put the games ## Where to put the games
OpenBOR games should be put under the `retrodeck/roms/openbor/` directory. OpenBOR games should be put under the `retrodeck/roms/openbor/` directory.

View file

@ -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. 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) [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) [Itch.io - Pico-8](https://lexaloffle.itch.io/pico-8)
---
## Where to put the games? ## Where to put the games?
PICO-8 games should be put under the `retrodeck/roms/pico8/` directory. PICO-8 games should be put under the `retrodeck/roms/pico8/` directory.

View file

@ -2,11 +2,13 @@
<img src="../../../wiki_images/logos/scummvm-logo.svg" width="150"> <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:** **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: ### ScummVM Links:
@ -20,6 +22,7 @@ This guide works for both the `ScummVM RetroArch Core` and `ScummVM-SA`
[ScummVM Webpage](https://www.scummvm.org/) [ScummVM Webpage](https://www.scummvm.org/)
---
### Where to put the games? ### Where to put the games?
@ -45,6 +48,8 @@ No
## How-to: Create .scummvm files that run in ES-DE ## How-to: Create .scummvm files that run in ES-DE
This guide works for both the `ScummVM-SA` and `ScummVM RetroArch Core`.
**Example:** **Example:**
In this example we got a game we want to add: `Beneath a Steel Sky` In this example we got a game we want to add: `Beneath a Steel Sky`

View file

@ -4,6 +4,9 @@
Solarus is an open-source adventure game engine. Solarus is an open-source adventure game engine.
---
### Solarus Links: ### Solarus Links:
[Solarus Community](https://www.solarus-games.org/community/) [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/) [Solarus Web page](https://www.solarus-games.org/)
---
## Where to put the games? ## Where to put the games?
Solarus games should be put under the `retrodeck/roms/solarus/` directory. Solarus games should be put under the `retrodeck/roms/solarus/` directory.

View file

@ -1,8 +1,15 @@
# ES-DE: General Guide # ES-DE Frontend: General Guide
<img src="../../../wiki_images/logos/es-de-logo.png" width="150"> <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: ### 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) [ES-DE Development: Roadmap](https://gitlab.com/es-de/emulationstation-de/-/blob/master/ROADMAP.md)
---
## Folder structure ## Folder structure
| Type | Folder | Comment | | Type | Folder | Comment |

View file

@ -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. 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. Not all ports are available for the `X86_64` system, but the list is continuously growing.
---
### PortMaster Links: ### 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) [PortMaster FAQ](https://portmaster.games/faq.html)
---
### Does PortMaster require BIOS / Firmware / Other files? ### 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. 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.

View file

@ -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. 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: ### 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/) [SteamGridDB](https://www.steamgriddb.com/)
---
### Warning - Flatpak Steam not yet supported ### Warning - Flatpak Steam not yet supported
We haven't added support for the Flatpak version of Steam yet. 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. 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. Currently, games are not added to Flatpak Steam via Steam Sync.