Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 6.09 KB

README.md

File metadata and controls

116 lines (80 loc) · 6.09 KB

RetroDECK logo

RetroDECK on your device!

screenshot screenshot

Instead of having several different emulators, engines and frontends on your Linux/SteamOS system you only need one: RetroDECK.

Flathub Flathub Discord GitHub Documentation Status

The RetroDECK Wiki & FAQ

Please check out the these links for even more information:

How do I start using RetroDECK?

Basically just download it from Flathub, put your roms/games and needed bioses and just play.

Read our getting started guide here:

How to: Start using RetroDECK

What devices/systems does RetroDECK support:

RetroDECK currently supports:

  • Steam Deck
  • Linux Desktop

For more information read up here:

Supported Systems

What is RetroDECK?

RetroDECK is a EmulationStation Desktop Edition (ES-DE) powered Linux Flatpak application 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.

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

How to get support?

Use the supports channels on Discord 🤝-community-support and 🆘-support.

The RetroDECK community:

Website
Wiki
Discord
Lemmy
Subreddit

Is RetroDECK in Beta?

Yes, here you can read more about the beta period:

RetroDECK: Beta period

Can I contribute to the project?

Yes, off course!
Read up here on how to help out, there is something for everyone:

How to: Contribute to RetroDECK

Our repositories:

Name Description
RetroDECK This one, our main repo where the core of the project is
RetroDECK-cooker Where we publish our test build, no code is hosted here
RetroDECK-Wiki Where our wiki source code is
RetroDECK-website Where our website source code is
RetroDECK on Flathub Our little space in Flathub's organization
RetroDECK-MAME MAME is big to build, so it's pre-built here and then imported in the build
RetroDECK-ES-DE This is where we store our patched fork of ES-DE

The RetroDECK Wiki

Please check out the Wiki for even more information.

The FAQ

The RetroDECK FAQ on the wiki has a vast variety of questions and awnsers.

How to get support?

Use the supports channels on Discord.