mirror of https://github.com/RetroDECK/RetroDECK.git synced 2024-11-22 14:05:39 +00:00

Find a file

monkeyx-net 2c51d4113f Removed some errors. Resize windows Emeulator selection highlight On branch cooker Changes to be committed: new file: assets/themes/emulators.tres modified: data_list.json modified: export_presets.cfg modified: main.gd modified: main.tscn deleted: rekku_animated.tscn modified: res/pixel_ui_theme/RetroDECKTheme.tres modified: res/pixel_ui_theme/random_icon.tres modified: scripts/class_functions.gd modified: tk_about.gd		2024-08-12 12:52:55 +01:00
.github	WORKFLOW: adding github token to elevate refwrite tag task permissions [skip ci]	2024-08-10 20:12:01 +09:00
automation_tools	Merge branch 'cooker' of https://github.com/monkeyx-net/RetroDECK_UK into cooker	2024-08-12 10:06:06 +01:00
config	ES-DE: theme was set not correctly	2024-08-11 21:53:36 +09:00
developer_toolbox	feat/lighter manifest (#844 )	2024-08-05 03:45:21 +02:00
functions	POST_UPDATE: 0.8.3b check, missing space fix [skip ci]	2024-08-12 12:14:09 +09:00
old	Merge branch 'cooker' into feat/lighter-manifest	2024-08-02 01:05:11 +09:00
rd-submodules/ryujinx	feat/lighter manifest (#844 )	2024-08-05 03:45:21 +02:00
res	added rainbows	2024-06-04 10:30:18 +02:00
tools	Removed some errors.	2024-08-12 12:52:55 +01:00
.gitattributes	Add gitattributes	2023-04-13 18:29:59 -04:00
.gitignore	DEVELOPER_TOOLBOX: fixing local build	2024-07-12 17:02:56 +09:00
LICENSE	Initial commit	2022-03-11 10:46:31 +09:00
net.retrodeck.retrodeck.appdata.xml	feat/lighter manifest (#844 )	2024-08-05 03:45:21 +02:00
net.retrodeck.retrodeck.Configurator.desktop	CONFIGURATOR: icon fixed	2024-03-19 22:30:52 +01:00
net.retrodeck.retrodeck.desktop	Migrated cooker to new domain	2022-04-24 10:35:28 +09:00
net.retrodeck.retrodeck.yml	PRE_BUILD_AUTOMATION: added THISREPO placeholder	2024-08-12 09:14:59 +09:00
other_licenses.txt	added other_licences file again	2024-05-05 10:42:03 +02:00
README.md	Migrated RetroDECK repo url [skip ci]	2024-08-02 00:57:19 +09:00
retrodeck.sh	FRAMEWORK: fixing online updater to point to the new org/repo	2024-08-06 11:08:54 +09:00

README.md

RetroDECK on your device!

screenshot

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

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 puts 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 which allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set on a per emulator basis to create a uniformity between them.

The RetroDECK Configurator is a Utility that exposes some parts of 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 activated 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
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

And many more, for the full list please check our repositories page on GitHub.

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 answers.

How to get support?

Use the supports channels on Discord.