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

Update README.md

Browse source
This commit is contained in:
Lazorne 2024-01-19 17:54:40 +00:00 committed by GitHub
parent da3f4fbb8b
commit 1900b40e0a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 26 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -25,15 +25,33 @@ Please check out the these links for even more information:
- [RetroDECK Wiki](https://retrodeck.readthedocs.io/en/latest/) - [RetroDECK Wiki](https://retrodeck.readthedocs.io/en/latest/)
- [RetroDECK FAQ](https://retrodeck.readthedocs.io/en/latest/wiki_general/faq/) - [RetroDECK FAQ](https://retrodeck.readthedocs.io/en/latest/wiki_general/faq/)
# What is RetroDECK? # How do I start using RetroDECK?
RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered [Flatpak application](https://flathub.org/apps/net.retrodeck.retrodeck) that thanks to its `RetroDECK 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. Basically just download it from Flathub, put your roms/games and needed bioses and just play.
## So what does that mean? Read our getting started guide here:
[How to: Start using RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_general/retrodeck-start/)
## What devices/systems does RetroDECK support:
RetroDECK currently supports:
- Steam Deck
- Linux Desktop
For more information read up here:
[Supported Systems](https://retrodeck.readthedocs.io/en/latest/wiki_general/supported-devices/)
## What is RetroDECK?
RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered Linux [Flatpak application](https://flathub.org/apps/net.retrodeck.retrodeck) that thanks to its `RetroDECK 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 provides all the emulators, systems and a frontend. RetroDECK configures them for you and put them into one application you can download from Flathub. It means that RetroDECK provides all the emulators, systems and a frontend. RetroDECK 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 to orchestrate them seamlessly. 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.
## The RetroDECK Framework
### The RetroDECK Framework
As previously mentioned, RetroDECK also adds the `RetroDECK Framework` 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` 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.
The `RetroDECK Configurator` is a `Utility` that some parts of exposes the `RetroDECK Framework` to the RetroDECK users. The `RetroDECK Configurator` is a `Utility` that some parts of exposes the `RetroDECK Framework` to the RetroDECK users.
@ -52,12 +70,10 @@ It can help with:
- Give access to global presets that can be acitivated to configure things over many emulators in one go like: `RetroAchievements` - 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` `Borders` `Widescreen Mode` `Swaping A/B X/Y for Nintendo Games`
For our long term vision you can check out the following wiki page: For our long term vision you can check out the following wiki page:
[RetroDECK: Visions and Goals](https://retrodeck.readthedocs.io/en/latest/wiki_about/visions-and-goals/) [RetroDECK: Visions and Goals](https://retrodeck.readthedocs.io/en/latest/wiki_about/visions-and-goals/)
### How to get support?
# How to get support?
Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g) `🤝-community-support` and `🆘-support`. Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g) `🤝-community-support` and `🆘-support`.
### The RetroDECK community: ### The RetroDECK community:
[Website](https://retrodeck.net) <br/> [Website](https://retrodeck.net) <br/>
@ -66,37 +82,17 @@ Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g) `🤝-comm
[Lemmy](https://lemmy.zip/c/retrodeck)<br/> [Lemmy](https://lemmy.zip/c/retrodeck)<br/>
[Subreddit](https://www.reddit.com/r/retrodeck) [Subreddit](https://www.reddit.com/r/retrodeck)
# How do I start using RetroDECK? ### Is RetroDECK in Beta?
Basically just download it from Discover, put your games and bioses and just play.
However, we have an in depth How To on how to get started over here:
[How to: Start using RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_general/retrodeck-start/)
## What devices/systems does RetroDECK support:
RetroDECK currently supports:
- Steam Deck
- Linux Desktop
For more information read up here:
[Supported Systems](https://retrodeck.readthedocs.io/en/latest/wiki_general/supported-devices/)
## Is RetroDECK in Beta?
Yes, here you can read more about the beta period: Yes, here you can read more about the beta period:
[RetroDECK: Beta period](https://retrodeck.readthedocs.io/en/latest/wiki_general/beta-period/) [RetroDECK: Beta period](https://retrodeck.readthedocs.io/en/latest/wiki_general/beta-period/)
### Can I contribute to the project?
## Can I contribute to the project?
Yes, off course! <br> Yes, off course! <br>
Read up here on how to help out, there is something for everyone: Read up here on how to help out, there is something for everyone:
[How to: Contribute to RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_community/contibute-rd/) [How to: Contribute to RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_community/contibute-rd/)
## Can I donate to the project? ### Can I donate to the project?
Yes, check here: <br> Yes, check here: <br>
[Donations & Licenses 🎁](https://retrodeck.readthedocs.io/en/latest/wiki_about/donations-licenses/) [Donations & Licenses 🎁](https://retrodeck.readthedocs.io/en/latest/wiki_about/donations-licenses/)