Xargon/RetroDECK
1
0
Fork 0
mirror of https://github.com/RetroDECK/RetroDECK.git synced 2024-11-27 00:05:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

WIKI: second batch of review

Browse source
This commit is contained in:
XargonWan 2023-12-02 14:03:57 +01:00
parent 7681e98f3a
commit 450cd4cfc9
4 changed files with 30 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
wiki-rtd/docs/index.md
View file

@ -11,7 +11,7 @@
![Discord](https://img.shields.io/discord/951662718102962256?label=discord)
![GitHub](https://img.shields.io/github/license/XargonWan/RetroDECK)
### RetroDECK on
### Find RetroDECK on...
[Flathub](https://flathub.org/apps/net.retrodeck.retrodeck)<br>
[Github](https://github.com/XargonWan/) <br/>

3
wiki-rtd/docs/wiki_general/beta-period.md
View file

@ -13,3 +13,6 @@ It means that the software is still under heavy development and big updates can
- RetroDECK is perfectly fine for daily use even during the beta phase and the core application should seen be stable. We still consider it beta since the want to add more features before a stable release. There are also experimental features that could be unstable but those are exclusive to the cooker builds or have to be enabled from commandline by testers.
- RetroDECK will still keep developing post the stable release.
# So what's the difference betwen this beta and the cooker version?
Since the beta is the actual mainline that is in fact the stable channel, the cooker version is the unstable, under development branch. More on that in the [FAQs](#what-is-retrodeck-cooker).

60
wiki-rtd/docs/wiki_general/configurator.md
View file

@ -2,13 +2,11 @@
The `RetroDECK Configurator` is a unique multi-use toolbox that exists within RetroDECK to manage/configure/change/reset/edit many aspect of the application and built around the `RetroDECK Framework`.
The`RetroDECK Configurator` can be found:
The `RetroDECK Configurator` can be called:
* In the main menu inside the ES-DE interface
* From CLI
* From the `.desktop` desktop shortcut.
* By the main menu inside the ES-DE interface (`START` > `RetroDECK Configurator``)
* From the `RetroDECK Configurator.desktop` desktop shortcut, available in your application menu.
* From CLI by calling `flatpak run net.retrodeck.retrodeck --configurator`
What follows are the commands you can use inside the Configurator (more commands will be added during development).
@ -61,39 +59,20 @@ Enable / Disable Venomalias's Universal Dynamic Input Texture for Primehack.
## Open Emulator
Here you launch and configure each emulators settings, the option you choose will open that emulators GUI. For documentation on how to change the settings of each emulators settings please check the website of each emulator.
(Please note that several emulators where not designed with controller input in mind for handling the applications GUI, just the games. So you might need to use other inputs like the Steam Decks touchscreen or a mouse and key board to navigate properly).
(Please note that most of the emulator interfaces where not designed with controller input in mind for handling the applications GUI, just the games. So you might need to use other inputs like the Steam Decks touchscreen or a mouse and key board to navigate properly).
The options are the following:
From this entry you can run the emualtor itself such as:
### RetroArch
Opens RetroArch
### Citra
Opens Citra
### Dolphin
Opens Dolphin
### Duckstation
Opens Duckstation
### MelonDS
Opens MelonDS
### PCSX2
Opens PCSX2
### PPSSPP
Opens PPSSPP
### RPCS3
Opens RPCS3
### XEMU
Opens XEMU
### Yuzu
Opens Yuzu
- RetroArch
- Citra
- Dolphin
- Duckstation
- MelonDS
- PCSX2
- PPSSPP
- RPCS3
- XEMU
- Yuzu
## RetroDECK: Tools
@ -114,9 +93,9 @@ You can choose either a single game or many.
This option installs the Steam Deck controller profile to RetroDECK it also resets all emulators configurations to input the correct bindings.
### Install: PS3 Firmware
This option downloads and installs the latest PS3 firmware. You will have to press OK to install it.
This option downloads and installs the latest PS3 firmware. A the end of the download, RPCS3 will open requesting the user to install it. Just press OK.
### RetroDECK: Change update settings
### RetroDECK: Change update settings (cooker only)
This option lets you turn on or off automatic updates on launch.
## RetroDECK: Troubleshooting
@ -141,8 +120,7 @@ Resets all the emulators at once
#### Reset RetroDECK
Resets the entirety of RetroDECK.
⚠️ WARNING! BACK UP YOUR DATA BEFORE RUNNING THIS! ⚠️
> ⚠️ WARNING! BACK UP YOUR DATA BEFORE RUNNING THIS! ⚠️
## RetroDECK: About
This menu contains information about RetroDECK

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

@ -24,13 +24,15 @@ No, RetroDECK doesn't support Windows currently and there are no plans to do so.
As an alternative you could try [RetroBat](https://www.retrobat.ovh) that offers similar functionality in a Windows environment.
How ever if you install a Linux distribution on your device instead you can try out RetroDECK.
### Will you support ARM devices like Android/IOS/MacOS.
### Will you support ARM devices like iOS or MacOS?
ARM devices are not supported currently. ES-DE does support the ARM emulators but it is a very different landscape.
It would be a major undertaking but maybe one day in the far off future it could be possible. But it would need to be a different experience as the emulators, other underlying systems would not be the same and would need to be rewritten.
### Will you make a snap version of RetroDECK?
Right now RetroDECKs main focus is flatpak. If the demand is very high for a snap version we might look into it post the launch of version 1.0.
### Will you support Android?
We believe that is not really possible to bundle and preconfigure external emulators on Android unfortunately.
### Will you make a appimage version of RetroDECK?
No, that is not within the scope of the project.
### Will you support other distribution methods usch as Snap or AppImage?
It's not in our roadmap yet as now the entire buildsystem is based on the flatpak-build that builds the software via flatpak manifest.
In the past we evaluated to migrate to **Buildstream** (or similar) to build in multiple output format, but the team is not large enough to migrate and maintain other distribution methods, so we prefer to focus our effort on Flatpak only.
If someone wishes to take charge of this we are open to discuss it.