RetroDECK/README.md

100 lines
4.6 KiB
Markdown
Raw Normal View History

<p float="center">
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="600"/>
</p>
2023-04-18 09:05:14 +00:00
# RetroDECK on your device!
2022-03-14 10:40:49 +00:00
2023-06-02 06:01:32 +00:00
<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/>
2023-04-18 10:59:02 +00:00
2023-10-23 16:24:27 +00:00
![Flathub](https://img.shields.io/flathub/downloads/net.retrodeck.retrodeck)
![Flathub](https://img.shields.io/flathub/v/net.retrodeck.retrodeck)
![Discord](https://img.shields.io/discord/951662718102962256?label=discord)
![GitHub](https://img.shields.io/github/license/XargonWan/RetroDECK)
[![Documentation Status](https://readthedocs.org/projects/retrodeck/badge/?version=latest)](https://retrodeck.readthedocs.io/en/latest/?badge=latest)
2023-06-22 04:53:20 +00:00
2023-10-23 16:24:27 +00:00
# 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.
2023-10-23 16:24:57 +00:00
2023-10-23 16:24:27 +00:00
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.
2023-06-22 04:53:20 +00:00
2023-10-23 17:02:16 +00:00
It's inspired by embedded emulation systems like:
2023-06-02 06:01:32 +00:00
2023-10-23 17:02:16 +00:00
- AmberELEC
- EmuELEC
- CoreELEC
- Lakka
- Batocera
2023-10-24 05:38:48 +00:00
The RetroDECK team consists of several veterans from some of the projects mentioned above as well as a bunch of other talented individuals.
2023-10-23 17:02:16 +00:00
2023-10-24 05:38:48 +00:00
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.
2023-06-22 05:25:51 +00:00
2023-10-23 17:08:10 +00:00
For our long term vision you can check out the following wiki page:
2023-06-02 06:02:21 +00:00
2023-10-23 16:24:27 +00:00
[RetroDECK: Visions and Goals](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Visions-and-Goals)
2023-06-02 06:02:21 +00:00
2023-10-23 16:24:27 +00:00
### The RetroDECK community:
2023-08-19 19:24:44 +00:00
2023-06-02 06:01:32 +00:00
[Website](https://retrodeck.net) <br/>
[Wiki](https://github.com/XargonWan/RetroDECK/wiki) <br/>
[Discord](https://discord.gg/Dz3szYsP8g)<br/>
2023-08-19 19:24:44 +00:00
[Lemmy](https://lemmy.zip/c/retrodeck)<br/>
2023-06-02 06:01:32 +00:00
[Subreddit](https://www.reddit.com/r/retrodeck)
2023-10-23 16:24:27 +00:00
# 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:
2023-10-23 16:24:27 +00:00
- Steam Deck
- Linux Desktop
2022-03-14 10:40:49 +00:00
2023-10-23 16:24:27 +00:00
For more information read up here:
[Supported Systems](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Supported-Systems)
2023-04-18 06:54:25 +00:00
2022-03-26 22:36:43 +00:00
2023-10-23 17:00:44 +00:00
## 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)
2023-12-22 16:15:12 +00:00
## Our repositories:
2023-12-22 16:17:29 +00:00
| Name | Description |
2023-12-22 16:16:42 +00:00
|-------------------------------------------------------------|-----------------------------------------------------------|
2023-12-22 16:17:29 +00:00
| [RetroDECK](https://github.com/XargonWan/RetroDECK) | This one, our main repo where the core of the project is |
2023-12-22 16:15:12 +00:00
| [RetroDECK-cooker](https://github.com/XargonWan/RetroDECK-cooker) | Where we publish our test build, no code is hosted here |
2023-12-22 16:16:42 +00:00
| [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 |
2023-10-23 17:00:44 +00:00
2023-10-23 16:24:27 +00:00
# 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.
2023-10-23 17:08:10 +00:00
# How to get support?
2023-10-23 17:09:14 +00:00
Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g).