mirror of
https://github.com/RetroDECK/RetroDECK.git
synced 2024-11-25 15:35:38 +00:00
152 lines
7.3 KiB
Markdown
152 lines
7.3 KiB
Markdown
### RetroDECK Wiki
|
||
<p float="center">
|
||
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="400"/>
|
||
</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Welcome to the **RetroDECK wiki**!
|
||
|
||
### 🏗️ This wiki is currently under construction 🏗️
|
||
|
||
# What is RetroDECK?
|
||
RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) powered 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 a tidy contained flatpak sandbox environment. It's inspired by embedded emulation systems like AmberELEC, EmuELEC, CoreELEC, Lakka, and Batocera.
|
||
|
||
You can also check out our: [Flathub Page](https://flathub.org/apps/net.retrodeck.retrodeck)<br/>
|
||
|
||
## 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
|
||
Technically it is working, but the user experience might not be that great it could contain desktop specific bugs and other issues.
|
||
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 flatpak support (else you will need to install it).<br>
|
||
We will start to have a bigger desktop focus after the beta period is over.
|
||
|
||
|
||
### Other SteamOS or Linux handheld gaming devices with flatpak support
|
||
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.
|
||
|
||
## Do you have any plans for other systems?
|
||
RetroDECK does not have plans to support Windows, macOS, Android, or iOS.<br>For similar functionality on Windows you could explore [Retrobat](https://www.retrobat.org/) as an alternative.
|
||
|
||
|
||
## How do I start using RetroDECK?
|
||
|
||
Please read the [How to: Getting started](https://github.com/XargonWan/RetroDECK/wiki/How-to:-Getting-started)
|
||
|
||
## RetroDECK is currently in in BETA and is not a full release.
|
||
|
||
- What does "currently in beta" mean?, It means that the software is still under heavy development and big updates can be made that change, add, or remove features.
|
||
|
||
- RetroDECK is missing some minor and major; emulators, features and configurations. The goal is to have them added over time.<br>
|
||
Please check the [Known Issues](https://github.com/XargonWan/RetroDECK/wiki/Known-Issues) page and the [Issue tracker](https://github.com/XargonWan/RetroDECK/issues) for more information.
|
||
|
||
- RetroDECK during the BETA period only supports the Steam Deck, but for the full release we should have full Linux Desktop support read more at [FAQs: General questions](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#general-questions).
|
||
- The "b" in the versioning stands for BETA but RetroDECK is perfectly fine for daily use even during the beta phase, albeit some features are missing. To see what features are missing check the: [Known Issues page](https://github.com/XargonWan/RetroDECK/wiki/Known-Issues).
|
||
|
||
## The RetroDECK community:
|
||
|
||
[Website](https://retrodeck.net) <br/>
|
||
[Discord](https://discord.gg/Dz3szYsP8g)<br/>
|
||
[Lemmy](https://lemmy.zip/c/retrodeck)<br/>
|
||
[Subreddit](https://www.reddit.com/r/retrodeck)<br/>
|
||
|
||
# Whats the long term vision and goals?
|
||
The long term vision and goals of the project is an all-in-one application to manage your entire retro games library that is:
|
||
|
||
- Already configured and should just work with your games.
|
||
|
||
- Has disaster recovery and multi device support: with cloud saves and syncs.
|
||
|
||
- Easy to install with one click installation.
|
||
|
||
- Easy to use and provide a "Console-like / Batocera-like" featured user experience.
|
||
|
||
- Easy to manage your collections of roms, mods and romhacks.
|
||
|
||
- As much as possible should be configurable from inside RetroDECK itself without needing to exiting the application.
|
||
|
||
- Make tighter integrations with bundled emulators and expose more features and ways to handle them to the end users.
|
||
|
||
- Should be secure, safe, and stable.
|
||
|
||
- Should have an easy way to mange external controllers and other inputs.
|
||
|
||
- Should support a majority of all supported Emulators in ES-DE
|
||
|
||
- Should in the long run support applications outside of the scope of ES-DE
|
||
|
||
- Should be plug and play and fill the need for a portable retro gaming solution that you can bring on the go to a friend’s/family/others house. Just dock into the TV and get going!
|
||
|
||
- Should fully support Steam Deck, SteamOS based devices and the Linux Desktop.
|
||
|
||
- AND MORE
|
||
|
||
# Can I contribute to the project?
|
||
Yes! Everybody is welcome to contribute in any way possible if it is personal time or funds.
|
||
|
||
- Do you know how to code and want to contribute? Please join the development team!
|
||
|
||
- Maybe you know graphics, art or UI & UX design? Join the discussion!
|
||
|
||
- You can just help by helping others in the support or guide people on various social media and communication platforms.
|
||
|
||
- You can also help by just finding and testing the best configurations for the emulators and the roms.
|
||
|
||
- Or just help us by doing bug reports on all the issues you find (please check old issues first before submitting a new one).
|
||
|
||
- By joining the ✨-new-helpers-start-here channel on [Discord](discord.gg/Dz3szYsP8g) and keeping an eye on the [issues](https://github.com/XargonWan/RetroDECK/issues) tab as well as the [Roadmap](https://github.com/XargonWan/RetroDECK/milestones) tab, you can be up to speed on the latest developments on RetroDECK.
|
||
|
||
- We have a [Patreon](https://www.patreon.com/RetroDECK) page if you want to help us keep our build servers running or just buy us a beverage.
|
||
|
||
## Any specific examples of what you need help with?
|
||
|
||
### Artist/Creators:
|
||
- Create new pixel art for the Radial menus.
|
||
|
||
- Create easter egg art for various holidays and functions.
|
||
|
||
- Create menu art for a new Configurator.
|
||
|
||
- Create input art that can be shown when you start a game.
|
||
|
||
- Create input art guides for the wiki for the Steam Deck and later various controllers.
|
||
|
||
- Create patch note and hype videos.
|
||
|
||
- Create instruction videos.
|
||
|
||
- Help us make RetroDECK better.
|
||
|
||
### Developers:
|
||
- Help us put in and make new features.
|
||
|
||
- Help us make the Configurator a godot application with full controller support.
|
||
|
||
- Help us get releases out faster.
|
||
|
||
- Help us make RetroDECK better.
|
||
|
||
### Testers:
|
||
- Help us test cooker builds and submit bugs and feedback.
|
||
|
||
- Help us make RetroDECK better.
|
||
|
||
### Everyone:
|
||
|
||
- Be kind and follow the rules.
|
||
|
||
- Spread the word of RetroDECK if you like it, if you don't like it or have suggestions put them on github into issues or discuss them on discord.
|
||
|
||
- Engage with the rest of the community.
|
||
|
||
- Help us make RetroDECK better.
|