RetroDECK/README.md

<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/>

![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)

# What is RetroDECK?
Instead of having several different software on your system for a variety of emulators and frontends you only need one: 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.

## 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. <br>
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
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.

**What can the RetroDECK Framework and by extent the RetroDECK Configurator do?**

It can help with:

- Compressing games
- Easier `Texture Pack` and `Mod` management
- File management
- Tools for troubleshooting (BIOS Checker, Multi-File Structure Checker, Partial or full reset of functions)
- Auto installing some free BIOSes
- Install prebuilt Steam Input profiles for devices like the Steam Deck and external controllers
- Easier management of `mods`, `roms`, `texture_packs`, `scraped media`, `screenshots`, `saves / states` `gamelists` and more
- 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`


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/)

### 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?
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_howto_faq/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:

[RetroDECK: Beta period](https://retrodeck.readthedocs.io/en/latest/wiki_general/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://retrodeck.readthedocs.io/en/latest/wiki_community/contibute-rd/)

## Can I donate to the project: 
Yes, check here: <br>
[Donations & Licenses 🎁](https://retrodeck.readthedocs.io/en/latest/wiki_about/donations-licenses/) 

# The RetroDECK Wiki
Please check out the [Wiki](https://retrodeck.readthedocs.io/en/latest/) for even more information.

## The FAQ
The RetroDECK [FAQ](https://retrodeck.readthedocs.io/en/latest/wiki_howto_faq/faq/) 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) `🤝-community-support` and `🆘-support`.
Update README.md Added screenshots, edited layout. 2022-04-19 10:59:32 +00:00			`<p float="center">`
			`<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="600"/>`
			`</p>`

Update README.md 2023-04-18 09:05:14 +00:00			`# RetroDECK on your device!`
Update README.md 2022-03-14 10:40:49 +00:00
Update README.md 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/>`
Update README.md 2023-04-18 10:59:02 +00:00
Update README.md 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)`
Update README.md 2023-06-22 04:53:20 +00:00
Update README.md 2023-10-23 16:24:27 +00:00			`# What is RetroDECK?`
Update README.md 2023-12-03 18:10:45 +00:00			`Instead of having several different software on your system for a variety of emulators and frontends you only need one: 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.
Update README.md 2023-06-22 04:53:20 +00:00
Update README.md 2023-12-03 18:10:45 +00:00			`## 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. <br>`
			`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.`
Update README.md 2023-06-02 06:01:32 +00:00
Update README.md 2023-12-03 18:10:45 +00:00			`## 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.
Update README.md 2023-10-23 17:02:16 +00:00
Update README.md 2023-12-03 18:10:45 +00:00			The `RetroDECK Configurator` is a `Utility` that some parts of exposes the `RetroDECK Framework` to the RetroDECK users.
Update README.md 2023-10-23 17:02:16 +00:00
Update README.md 2023-12-03 18:10:45 +00:00			`What can the RetroDECK Framework and by extent the RetroDECK Configurator do?`
Update README.md 2023-06-22 05:25:51 +00:00
Update README.md 2023-12-03 18:10:45 +00:00			`It can help with:`

			`- Compressing games`
			- Easier `Texture Pack` and `Mod` management
			`- File management`
			`- Tools for troubleshooting (BIOS Checker, Multi-File Structure Checker, Partial or full reset of functions)`
			`- Auto installing some free BIOSes`
			`- Install prebuilt Steam Input profiles for devices like the Steam Deck and external controllers`
			- Easier management of `mods`, `roms`, `texture_packs`, `scraped media`, `screenshots`, `saves / states` `gamelists` and more
			- 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`
Update README.md 2023-06-02 06:02:21 +00:00
Update README.md 2023-12-03 18:10:45 +00:00
			`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/)`
Update README.md 2023-06-02 06:02:21 +00:00
Update README.md 2023-10-23 16:24:27 +00:00			`### The RetroDECK community:`
Update README.md 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/>`
Update README.md Added Lemmy 2023-08-19 19:24:44 +00:00			`[Lemmy](https://lemmy.zip/c/retrodeck)<br/>`
Update README.md 2023-06-02 06:01:32 +00:00			`[Subreddit](https://www.reddit.com/r/retrodeck)`

Update README.md 2023-10-23 16:24:27 +00:00			`# How do I start using RetroDECK?`
Update README.md 2024-01-03 13:17:07 +00:00			`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:`
Update README.md 2023-10-23 16:24:27 +00:00
Update README.md 2023-12-03 18:10:45 +00:00			`[How to: Start using RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_howto_faq/retrodeck-start/)`
Update README.md 2023-10-23 16:24:27 +00:00
			`## What devices/systems does RetroDECK support:`
			`RetroDECK currently supports:`
Update README.md Added screenshots, edited layout. 2022-04-19 10:59:32 +00:00
Update README.md 2023-10-23 16:24:27 +00:00			`- Steam Deck`
			`- Linux Desktop`
Update README.md 2022-03-14 10:40:49 +00:00
Update README.md 2023-10-23 16:24:27 +00:00			`For more information read up here:`

Update README.md 2023-12-03 18:10:45 +00:00			`[Supported Systems](https://retrodeck.readthedocs.io/en/latest/wiki_general/supported-devices/)`
Update README.md 2023-04-18 06:54:25 +00:00
Update README.md 2022-03-26 22:36:43 +00:00
Update README.md 2023-10-23 17:00:44 +00:00			`## Is RetroDECK in Beta?`
			`Yes, here you can read more about the beta period:`

Update README.md 2023-12-03 18:10:45 +00:00			`[RetroDECK: Beta period](https://retrodeck.readthedocs.io/en/latest/wiki_general/beta-period/)`
Update README.md 2023-10-23 17:00:44 +00:00

			`## Can I contribute to the project?`
			`Yes, off course! <br>`
			`Read up here on how to help out, there is something for everyone:`

Update README.md 2023-12-03 18:10:45 +00:00			`[How to: Contribute to RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_community/contibute-rd/)`
Update README.md 2023-10-23 17:00:44 +00:00
Update README.md Added Donations & Licenses 🎁 2024-01-10 07:04:53 +00:00			`## Can I donate to the project:`
			`Yes, check here: <br>`
			`[Donations & Licenses 🎁](https://retrodeck.readthedocs.io/en/latest/wiki_about/donations-licenses/)`
Update README.md 2023-10-23 17:00:44 +00:00
Update README.md 2023-10-23 16:24:27 +00:00			`# The RetroDECK Wiki`
Update README.md 2023-12-03 18:10:45 +00:00			`Please check out the [Wiki](https://retrodeck.readthedocs.io/en/latest/) for even more information.`
Update README.md 2023-10-23 16:24:27 +00:00
			`## The FAQ`
Update README.md 2023-12-03 18:10:45 +00:00			`The RetroDECK [FAQ](https://retrodeck.readthedocs.io/en/latest/wiki_howto_faq/faq/) on the wiki has a vast variety of questions and awnsers.`
Update README.md 2023-10-23 17:08:10 +00:00
			`# How to get support?`
Update README.md 2024-01-03 13:17:07 +00:00			Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g) `🤝-community-support` and `🆘-support`.