Xargon/RetroDECK
1
0
Fork 0
mirror of https://github.com/RetroDECK/RetroDECK.git synced 2025-02-16 11:25:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

WIKI: first batch of review

Browse source
This commit is contained in:
XargonWan 2023-12-01 10:08:45 +01:00
parent ca457cbc47
commit df4338ab4c
12 changed files with 50 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.gitignore vendored
View file

@ -17,8 +17,10 @@ backup
.old
tmp
.godot
rd-submodules/es-de/patches-tmp
rd-submodules/es-de/patches-tmp*
.local/
buildid
# Python #
##########
__pycache__
__pycache__

4
wiki-rtd/docs/wiki_development/cli-guide.md
View file

@ -51,14 +51,14 @@ Where the argument `--reset-all` replaced `[ARGUMENTS]` and `[FLATPAK-RUN-OPTION
# General flatpak commands
If you want to check RetroDECK's flathub page [click here](https://flathub.org/apps/details/net.retrodeck.retrodeck)<br>
If you want to check RetroDECK's Flathub page [click here](https://flathub.org/apps/details/net.retrodeck.retrodeck)<br>
Here follows some general flatpak commands that could be useful: <br>
## Install RetroDECK from CLI
If you want to install RetroDECK from CLI type:<br>
`flatpak install flathub net.retrodeck.retrodeck`
`flatpak install Flathub net.retrodeck.retrodeck`
NOTE! This will work on the Steam Deck out of the box.<br>
But on the Linux desktop you need to check your distribution if it ships with both Flatpak and Flathub integration installed, if not you may need to install it. Check your distributions or flathubs documentation on how to install it on your desktop.

2
wiki-rtd/docs/wiki_development/general-development.md
View file

@ -22,7 +22,7 @@ git submodule update
install `flatpak flatpak-builder p7zip-full` with your distro's package manager, then:
```
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak remote-add --if-not-exists Flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install --user -y org.kde.Sdk//5.15-21.08 org.kde.Platform//5.15-21.08 io.qt.qtwebengine.BaseApp/x86_64/5.15-21.08 org.freedesktop.Sdk.Extension.llvm13 org.freedesktop.Platform.ffmpeg-full/x86_64/21.08
```

2
wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md
View file

@ -19,7 +19,7 @@ https://flatpak.org/setup/
## From the terminal
- Run the following command `flatpak install flathub net.retrodeck.retrodeck`
- Run the following command `flatpak install Flathub net.retrodeck.retrodeck`
# First Run - Quick Start

6
wiki-rtd/docs/wiki_devices/linux_desktop/linux-software.md
View file

@ -4,7 +4,7 @@ The following software works great with the Linux Desktop and might enhance your
## Flips
Flips is a software that let you patch romhacks IPS & BPS files onto the rom files.
It's already on flathub.
It's already on Flathub.
_Made by Alcaro_
@ -12,7 +12,7 @@ _Made by Alcaro_
## BoilR
BoilR will show games from other games platforms in your Steam library. It uses the Steam 3rd party shortcuts feature and does not require you to set up anything. You can also use BoilR to manually and automatically download custom art from SteamGridDB. It's already in flathub.
BoilR will show games from other games platforms in your Steam library. It uses the Steam 3rd party shortcuts feature and does not require you to set up anything. You can also use BoilR to manually and automatically download custom art from SteamGridDB. It's already in Flathub.
_Made by Philipk_
@ -20,7 +20,7 @@ _Made by Philipk_
## JRomManager
A Mame and Retrogaming Rom Manager. <br>
This more complex application allows you to manage and verify your roms via .dat files. It's already in on flathub and downloadable in Discover.
This more complex application allows you to manage and verify your roms via .dat files. It's already in on Flathub and downloadable in Discover.
_Made by optyfr_

2
wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-software.md
View file

@ -11,7 +11,7 @@ _Made by CryoByte33_
## Discover Overlay
If you use Discord this is a program that adds Discord integration into the Steam Deck's gamemode UI.
It's already in on flathub and downloadable in Discover. Note that you need to install and login to Discord as well.
It's already in on Flathub and downloadable in Discover. Note that you need to install and login to Discord as well.
_Made by trigg_

9
wiki-rtd/docs/wiki_general/supported-devices.md
View file

@ -2,11 +2,16 @@
RetroDECK currently supports two systems:
- Steam Deck itself
- Other SteamOS devices
- The Linux Desktop
- SteamOS devices like the Steam Deck.
## Steam Deck LCD/OLED
Supported from the start and RetroDECK is tailored to the Steam Deck.
Supported from the beginning. RetroDECK is tailored to the Steam Deck.
## Other SteamOS devices
Hence there are no any other devices that are coming with SteamOS at the moment of writing, it's in the plan of Valve to distribute this OS and make it available to the hardware manifacturers and users.
We plan to fully support the OS itself, about the single hardware it will be decided case by case.
## Linux Desktop
It is working, but the user experience might not be that great it as we want it to be just yet.

30
wiki-rtd/docs/wiki_general/what-is-included.md
View file

@ -1,7 +1,7 @@
# RetroDECK: What's included?
## General information
We plan to add more emulators and functions over course of the development cycle. The goal is to support all of the systems ES-DE supports and ship the best emulator for that systems. We don't have any plans to ship all emulators in existence for each system.
We plan to add more emulators and functions over course of the development cycle. The goal is to support all of the systems ES-DE supports and ship the best emulator for that systems. We don't have any plans to ship all emulators in existence for each system but virtually only the best one per-system (this is more theoretical than practical) to avoid confusion and the user being loss in the choice.
## Systems
@ -9,7 +9,7 @@ We plan to add more emulators and functions over course of the development cycle
Emulationstation Desktop Edition (ES-DE) is the base frontend for RetroDECK. RetroDECK comes with specific tweaks to the ES-DE standard setup to enable RetroDECK unique functions like the `RetroDECK Framework` and `RetroDECK Configurator`. These tweaks are possible thanks to a collaborations with the ES-DE project and the RetroDECK project.
### The RetroDECK Configurator
Is a powerfull Utility that can be use to change/modify and manipulate various aspects of RetroDECK.
Is a powerful Utility that can be use to change/modify and manipulate various aspects of RetroDECK.
## Emulators
@ -18,17 +18,23 @@ RetroDECK ships will all cores under the stable branch of RetroArch.
## Standalone Emulators
The following standalone emulators are included
- Yuzu (Switch)
- Citra (3DS)
- PCSX2 (PS2)
- Cemu (WiiU)
- Dolphin (GameCube/Wii)
- Primehack (Metroid Prime - Dolphin Fork)
- Xemu (XBOX)
- MelondDS (DS)
- RPCS3 (PS3)
- PPSSPP (PSP)
### Yuzu (Switch)
### Citra (3DS)
### PCSX2 (PS2)
### Cemu (WiiU)
### Dolphin (GameCube/Wii)
### Primehack (Metroid Prime - Dolphin Fork)
### Xemu (XBOX)
### MelondDS (DS)
### RPCS3 (PS3)
### PPSSPP (PSP)
These instead are being added soon:
- GZDoom (Doom engine)
- MAME (Standalone)
- Ryujinx (Switch)
- Solarus (engine)
- Vita3K (PSVita)

18
wiki-rtd/docs/wiki_general/what-is-retrodeck.md
View file

@ -4,25 +4,25 @@
Instead of having several different software on your system for a variety of emulators and frontends you only need to have one: RetroDECK.
RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered flatpak application that builds-in a variety of emulators and other software that allows you to play your favorite retro (and even not-so-retro) games in one complete package.
RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered flatpak application that thanks to its framework it builds-in and manage a variety of emulators and other software that allows you to play your favorite retro (and even not-so-retro) games in one complete package.
## So what does that mean?
It means that RetroDECK takes all the emulators and frontend, configures them for you and put them into one application you can download from flathub.
It means that RetroDECK provides all the emulators and frontend, configures them for you and put them into one application you can download from Flathub.
By being one application RetroDECK can put all important files in one location for all the emulators, instead of having them spread out over your entire system and even add features on top.
By being one application RetroDECK can put all important files in one location for all the emulators, instead of having them spread out over your entire system and even add features on top to orchestrate them seamlessly.
## What else?
RetroDECK also adds the `RetroDECK Framework` and the `RetroDECK Configurator` on top of the emulators and ES-DE interface that allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set per emulator basis to create a uniformity between them.
As previously mentioned, RetroDECK also adds the `RetroDECK Framework` and the `RetroDECK Configurator` on top of the emulators and ES-DE interface that allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set per emulator basis to create a uniformity between them.
**What can the RetroDECK Framework do?**
It can help with:
- Compressing games.
- File management.
- Compressing games
- File management
- Tools for troubleshooting (BIOS Checker, Multi-File Structure Checker, Partial or full reset of functions)
- Auto installing some BIOSes
- Install prebuilt Steam Input profiles for devices like the Steam Deck and external controllers.
- Easier management of `mods` `roms` `texture_packs` `scraped media` `screenshots` `saves / states` `gamelists` and more.
- Auto installing some free BIOSes
- Install prebuilt Steam Input profiles for devices like the Steam Deck and external controllers
- Easier management of `mods`, `roms`, `texture_packs`, `scraped media`, `screenshots`, `saves / states` `gamelists` and more
- Give access to global presets that can be acitivated to configure things over many emulators in one go like: `RetroAchievements`
`Borders` `Widescreen Mode` `Swaping A/B X/Y for Nintendo Games`

4
wiki-rtd/docs/wiki_howto_faq/faq.md
View file

@ -77,7 +77,7 @@ For purchased titles we recommend that you use your own game backups and look in
#### How is a flatpak made?
<details><summary>Click here to see the answer</summary>
A flatpak is generated from a manifest file. A software called flatpak-builder reads the manifest, then starts downloading dependencies and starts building the software. After the build process is done it generates the software in a .flatpak file. This file can then be hosted on flathub or distributed on the web.
A flatpak is generated from a manifest file. A software called flatpak-builder reads the manifest, then starts downloading dependencies and starts building the software. After the build process is done it generates the software in a .flatpak file. This file can then be hosted on Flathub or distributed on the web.
</details>
#### How does the RetroDECK flatpak manifest look like?
@ -349,7 +349,7 @@ No, but RetroDECK had some dialog before the project started with some of the Ba
- EmuDeck is a shell script that you download and run. The script downloads & configures all the separate emulators & plugins for you from various sources for various operative systems.
- RetroDECK is an all-in-one application that already provides everything you need without to many extra steps for the user.It is on flathub and thus allows the users to update the application via standard safe operative system update methods.
- RetroDECK is an all-in-one application that already provides everything you need without to many extra steps for the user.It is on Flathub and thus allows the users to update the application via standard safe operative system update methods.
You can see RetroDECK as the in between of EmuDeck and Batocera. We hope that one day we can offer a complete Batocera-like experience right inside your operative system.
</details>

2
wiki-rtd/docs/wiki_howto_faq/retrodeck-move.md
View file

@ -25,7 +25,7 @@ After that you can keep following following the installation guide [[Steam Deck:
### Linux Desktop
1. Back up existing the RetroDECK `~/retrodeck` folder .
2. On the new PC install RetroDECK from flathub via your application manager.
2. On the new PC install RetroDECK from Flathub via your application manager.
3. Do not launch RetroDECK on your new device until you have copied over the backed up folders.
4. Copy over the backup folder to the same location (or new) on the new device.
5. Launch RetroDECK on the new device and point towards the `~/retrodeck` location during installation.

2
wiki-rtd/docs/wiki_howto_faq/retrodeck-start.md
View file

@ -12,7 +12,7 @@ You need to meet the following prerequisites before you start following this gui
* Have game backups of various formats ready that you want to play
## Step 1: Installation & Configuration
Only install RetroDECK from the official channels via flathub!
Only install RetroDECK from the official channels via Flathub!
### Steam Deck - Installation<br>
Read and follow the following guide