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

Update README.md

Browse source
This commit is contained in:
Lazorne 2023-06-22 05:18:26 +00:00 committed by GitHub
parent 677ad67a38
commit 036710da0e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -22,25 +22,27 @@ RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) powered app
You can also check out our: [Flathub Page](https://flathub.org/apps/net.retrodeck.retrodeck)<br/>
## RetroDECK officially supports the following devices/systems:
**Note:**
<br>
You can get it to run on other Linux based devices or Linux Desktop today, it is not just as seamless as we want it to be and does not live up to our higher standards.<br/>
You will need to manually configure the input to match your device and might need to tweak more settings if you try it on a none Steam Deck device. There might also be some hardware specific bugs.
## What devices/systems does RetroDECK support:
### Steam Deck
Supported from the start and RetroDECK is tailored to the Steam Deck during the BETA period. The goal is that all the configurations are ready out-of-the-box and optimized towards the Steam Deck.
### Linux Desktop
It semi-works today but most inputs are configured for the Steam Deck during the beta period. We will have a bigger desktop focus after the beta period is over and there can be desktop specific bugs.
Technically it is working, but the user experience might not be that great it could contain desktop specific bugs and other issues. <br/>
You will also need to manually configure the input to match your desktop and might need to tweak more settings. If you want to try it make sure that your distribution has native flatpak support else, you might need to install it. <br/>
We will have a bigger desktop focus after the beta period is over.
### Other SteamOS or Linux handheld gaming devices with flatpak support
After the BETA period.
We do plan to support other SteamOS based devices in the future. But during the BETA we are focusing on the Steam Deck.<br/>
You can get it to run on other Linux based devices it is not just as seamless as we want it to be and does not live up to our higher standards.<br/>
You will need to manually configure the input to match your device and might need to tweak more settings if you try it on a none Steam Deck device. There might also be some hardware specific bugs.
### Windows/MacOS
### Windows
Not supported and not planned.
As an alternative you could try [Retrobat](https://www.retrobat.org/) that offers similar functionality.
### MacOS
Not supported and not planned.
### Android/IOS
@ -63,17 +65,6 @@ Please read the [Wiki](https://github.com/XargonWan/RetroDECK/wiki) for even mor
## Do I have to partition or format my disk/sdcard to install it?
No, partitioning or formatting is not needed at all. RetroDECK (differently from AmberELEC, Batocera and others) comes as a flatpak. Just install it as any other application and launch it from your desktop and/or Steam library.
## Do you support Windows?
No, RetroDECK doesn't support Windows, but the project is fully open source so you can port it if you wish.
As an alternative you could try [Retrobat](https://www.retrobat.org/) that offers similar functionality.
## Do you support the Linux Desktop?
We do plan to support Linux Desktop in the future. But during the BETA we are focusing on the Steam Deck. Technically it is working, but the user experience might not be that great (it could contain desktop specific bugs and other issues). If you want to try it make sure that your distribution has native flatpak support else, you might need to install it.
## Do you support other SteamOS based devices?
We do plan to support other SteamOS based devices in the future. But during the BETA we are focusing on the Steam Deck.
You can still run it but you might need to do some configurations by yourself.
## Can I contribute to the project?
Yes! Everybody is welcome to contribute in any way possible if it is personal time or funds, just check out our [Discord](https://discord.gg/Dz3szYsP8g)!
- Do you know how to code and want to contribute? Please join the development team!