mirror of
https://github.com/RetroDECK/RetroDECK.git
synced 2024-11-22 05:55:38 +00:00
100 lines
4.6 KiB
Markdown
100 lines
4.6 KiB
Markdown
<p float="center">
|
|
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="600"/>
|
|
</p>
|
|
|
|
# RetroDECK on your device!
|
|
|
|
<p float="center">
|
|
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/screenshots/screen03.jpeg?raw=true" alt="screenshot" width="300"/>
|
|
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/screenshots/screen04.jpeg?raw=true" alt="screenshot" width="300"/><br/>
|
|
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/screenshots/screen05.jpeg?raw=true" alt="screenshot" width="300"/>
|
|
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/screenshots/screen06.jpeg?raw=true" alt="screenshot" width="300"/>
|
|
</p>
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
[](https://retrodeck.readthedocs.io/en/latest/?badge=latest)
|
|
|
|
# What is RetroDECK?
|
|
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.
|
|
|
|
It's inspired by embedded emulation systems like:
|
|
|
|
- AmberELEC
|
|
- EmuELEC
|
|
- CoreELEC
|
|
- Lakka
|
|
- Batocera
|
|
|
|
The RetroDECK team consists of several veterans from some of the projects mentioned above as well as a bunch of other talented individuals.
|
|
|
|
RetroDECK also adds the `RetroDECK Framework` and the `RetroDECK Configurator` on top of the emulators and ES-DE frontend 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.
|
|
|
|
For our long term vision you can check out the following wiki page:
|
|
|
|
[RetroDECK: Visions and Goals](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Visions-and-Goals)
|
|
|
|
### The RetroDECK community:
|
|
|
|
[Website](https://retrodeck.net) <br/>
|
|
[Wiki](https://github.com/XargonWan/RetroDECK/wiki) <br/>
|
|
[Discord](https://discord.gg/Dz3szYsP8g)<br/>
|
|
[Lemmy](https://lemmy.zip/c/retrodeck)<br/>
|
|
[Subreddit](https://www.reddit.com/r/retrodeck)
|
|
|
|
# How do I start using RetroDECK?
|
|
|
|
We have an in depth How To on how to get started over here:
|
|
|
|
[How to: Start using RetroDECK](https://github.com/XargonWan/RetroDECK/wiki/How-to%3A-Start-using-RetroDECK)
|
|
|
|
## What devices/systems does RetroDECK support:
|
|
|
|
RetroDECK currently supports:
|
|
|
|
- Steam Deck
|
|
- Linux Desktop
|
|
|
|
For more information read up here:
|
|
|
|
[Supported Systems](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Supported-Systems)
|
|
|
|
|
|
## Is RetroDECK in Beta?
|
|
Yes, here you can read more about the beta period:
|
|
|
|
[RetroDECK: Beta period](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Beta-period)
|
|
|
|
|
|
## Can I contribute to the project?
|
|
|
|
Yes, off course! <br>
|
|
Read up here on how to help out, there is something for everyone:
|
|
|
|
[How to: Contribute to RetroDECK](https://github.com/XargonWan/RetroDECK/wiki/How-to%3A-Contribute-to-RetroDECK)
|
|
|
|
## Our repositories:
|
|
| Name | Description |
|
|
|-------------------------------------------------------------|-----------------------------------------------------------|
|
|
| [RetroDECK](https://github.com/XargonWan/RetroDECK) | This one, our main repo where the core of the project is |
|
|
| [RetroDECK-cooker](https://github.com/XargonWan/RetroDECK-cooker) | Where we publish our test build, no code is hosted here |
|
|
| [RetroDECK on Flathub](https://github.com/flathub/net.retrodeck.retrodeck) | Our little space in Flathub's organization |
|
|
| [RetroDECK-MAME](https://github.com/XargonWan/RetroDECK-MAME) | MAME is big to build, so it's pre-built here and then imported in the build |
|
|
| [RetroDECK-ES-DE](https://github.com/XargonWan/RetroDECK-ES-DE) | This is where we store our patched fork of ES-DE |
|
|
|
|
|
|
# The RetroDECK Wiki
|
|
|
|
Please check out the [Wiki](https://github.com/XargonWan/RetroDECK/wiki) for even more information.
|
|
|
|
## The FAQ
|
|
The RetroDECK [FAQ](https://github.com/XargonWan/RetroDECK/wiki/FAQs%3A-Frequently-asked-questions) on the wiki has a vast variety of questions and awnsers.
|
|
|
|
# How to get support?
|
|
Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g).
|