mirror of
https://github.com/RetroDECK/RetroDECK.git
synced 2024-11-25 15:35:38 +00:00
Merge remote-tracking branch 'upstream/main' into cooker-0.7.0b-icenine451
This commit is contained in:
commit
b27a687960
8
.github/workflows/main-selfhosted.yml
vendored
8
.github/workflows/main-selfhosted.yml
vendored
|
@ -4,6 +4,14 @@ on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
paths:
|
||||||
|
- '.github/workflows/**'
|
||||||
|
- 'emu-configs/**'
|
||||||
|
- 'es-configs/**'
|
||||||
|
- 'rd-submodules/**'
|
||||||
|
- '*.sh'
|
||||||
|
- 'net.retrodeck.retrodeck.yml'
|
||||||
|
- 'net.retrodeck.retrodeck.appdata.xml'
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
|
63
README.md
63
README.md
|
@ -7,15 +7,24 @@
|
||||||
![Discord](https://img.shields.io/discord/951662718102962256?label=discord)
|
![Discord](https://img.shields.io/discord/951662718102962256?label=discord)
|
||||||
![GitHub](https://img.shields.io/github/license/XargonWan/RetroDECK)
|
![GitHub](https://img.shields.io/github/license/XargonWan/RetroDECK)
|
||||||
|
|
||||||
# RetroDECK
|
# RetroDECK on your device!
|
||||||
|
|
||||||
**RetroDECK** brings an environment to catalog and play your retro games directly from SteamOS and it's tailored specifically for the **Steam Deck**.
|
You can visit our:<br/>
|
||||||
|
[Website](https://retrodeck.net) <br/>
|
||||||
|
[Wiki](https://github.com/XargonWan/RetroDECK/wiki) <br/>
|
||||||
|
[Discord](https://discord.gg/Dz3szYsP8g)
|
||||||
|
|
||||||
It's inspired by embedded emulation systems like AmberELEC, EmuELEC, CoreELEC, Lakka, and Batocera.
|
## 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 sandbox environment. It's inspired by embedded emulation systems like AmberELEC, EmuELEC, CoreELEC, Lakka, and Batocera.
|
||||||
|
|
||||||
Powered by [EmulationStation Desktop Edition](https://es-de.org), which uses RetroArch and other standalone emulators to allow you to import and play your favorite retro (and even not-so-retro) games in a tidy environment without flooding your Steam library.
|
RetroDECK supports the following devices:
|
||||||
|
<br/><br/>
|
||||||
|
**Steam Deck**
|
||||||
|
<br/>
|
||||||
|
**Linux Desktop** (after the BETA period)
|
||||||
|
<br/>
|
||||||
|
**Other SteamOS devices** (after the BETA period)
|
||||||
|
|
||||||
Visit our [website](https://retrodeck.net) and Join our [Discord](https://discord.gg/Dz3szYsP8g)!
|
|
||||||
<p float="center">
|
<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/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/screen04.jpeg?raw=true" alt="screenshot" width="300"/><br/>
|
||||||
|
@ -24,22 +33,40 @@ Visit our [website](https://retrodeck.net) and Join our [Discord](https://discor
|
||||||
</p>
|
</p>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## What does it mean to be "tailored for the Steam Deck"?
|
### RetroDECK is tailored to the Steam Deck during the BETA period.
|
||||||
It means that all the configurations are ready to go and tweaked to get the best graphics and performance on the Deck without having the hassle of choosing, installing and configuring tons of emulators: just put your games in the roms folder, provide your own bioses and start your games.
|
The goal is that all the configurations are ready out-of-the-box and optimized towards the Steam Deck. Just put your `ROMS` & `BIOS` in the corresponding folders and start playing.
|
||||||
|
|
||||||
## Do I have to partition my disk to install it?
|
### How do I install RetroDECK?
|
||||||
No partitioning or formatting is required. RetroDECK (differently from AmberELEC, Batocera and others) comes as a flatpak: just install it as any other application and launch it from your desktop or Steam library. You still retain the ability to return to SteamOS by pressing the Steam button or opening the Quick Access menu while using RetroDECK.
|
Read and follow the guide here: [Installation instructions](https://github.com/XargonWan/RetroDECK/wiki/How-to:-Getting-started) on the Wiki
|
||||||
|
|
||||||
## Is it available on Windows?
|
# Short FAQ
|
||||||
No, RetroDECK doesn't support Windows, but the project is fully open source so you can port it if you wish. As an alternative, [Retrobat](http://www.retrobat.ovh/) offers similar functionality (but may not be compatible with RetroDECK's rom paths).
|
|
||||||
|
|
||||||
## How can I install it?
|
Please read the [Wiki](https://github.com/XargonWan/RetroDECK/wiki) for even more information.
|
||||||
Just install it from Discover store.<br/>
|
|
||||||
However if you want to test the cooker version you can follow the [Installation instructions](https://github.com/XargonWan/RetroDECK/wiki/How-to:-Getting-started) on the Wiki
|
|
||||||
|
|
||||||
## Can I help?
|
## Do I have to partition or format my disk/sdcard to install it?
|
||||||
Of course, any help is appreciated, and not only by programming, just check out our [Discord](https://discord.gg/Dz3szYsP8g)!
|
No, partitioning or formatting is not needed at all. RetroDECK (differently from AmberELEC, Batocera and others) comes as a flatpak. Just install it as any other application and launch it from your desktop and/or Steam library.
|
||||||
<br/><br/><br/>
|
|
||||||
|
|
||||||
|
## Do you support Windows?
|
||||||
|
No, RetroDECK doesn't support Windows, but the project is fully open source so you can port it if you wish.
|
||||||
|
As an alternative you could try [Retrobat](https://www.retrobat.org/) that offers similar functionality.
|
||||||
|
|
||||||
###### *The Steam Deck logo is a registered trademark of Valve Corporation. This project is in no way officially affiliated with Valve.<br/>All trademarks, logos and brand names are the property of their respective owners. All company, product and service names used in this project are for identification purposes only. Use of these names, trademarks and brands does not imply endorsement.*
|
## Do you support the Linux Desktop?
|
||||||
|
We do plan to support Linux Desktop in the future. But during the BETA we are focusing on the Steam Deck. Technically it is working, but the user experience might not be that great (it could contain desktop specific bugs and other issues). If you want to try it make sure that your distribution has native flatpak support else, you might need to install it.
|
||||||
|
|
||||||
|
## Do you support other SteamOS based devices?
|
||||||
|
We do plan to support other SteamOS based devices in the future. But during the BETA we are focusing on the Steam Deck.
|
||||||
|
You can still run it but you might need to do some configurations by yourself.
|
||||||
|
|
||||||
|
## Can I contribute to the project?
|
||||||
|
Yes! Everybody is welcome to contribute in any way possible if it is personal time or funds, just check out our [Discord](https://discord.gg/Dz3szYsP8g)!
|
||||||
|
- 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
|
||||||
|
|
||||||
|
###### The Steam Deck logo is a registered trademark of Valve Corporation. This project is in no way officially affiliated with Valve.<br/>
|
||||||
|
|
||||||
|
###### All trademarks, logos and brand names are the property of their respective owners. All company, product and service names used in this project are for identification purposes only. Use of these names, trademarks and brands does not imply endorsement.
|
||||||
|
|
|
@ -79,6 +79,16 @@
|
||||||
</ul>
|
</ul>
|
||||||
</description>
|
</description>
|
||||||
</release>
|
</release>
|
||||||
|
<release version="0.6.6b" date="2023-04-26">
|
||||||
|
<url>https://github.com/XargonWan/RetroDECK/releases/tag/0.6.6b</url>
|
||||||
|
<description>
|
||||||
|
<p>Bug fixes:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Fixed ES-DE that was showing the update notification</li>
|
||||||
|
<li>PSX: Swanstation is back as default emulator</li>
|
||||||
|
</ul>
|
||||||
|
</description>
|
||||||
|
</release>
|
||||||
<release version="0.6.5b" date="2023-04-07">
|
<release version="0.6.5b" date="2023-04-07">
|
||||||
<url>https://github.com/XargonWan/RetroDECK/releases/tag/0.6.5b</url>
|
<url>https://github.com/XargonWan/RetroDECK/releases/tag/0.6.5b</url>
|
||||||
<description>
|
<description>
|
||||||
|
|
BIN
res/icon.afphoto
Normal file
BIN
res/icon.afphoto
Normal file
Binary file not shown.
BIN
res/icon_alt.afphoto
Normal file
BIN
res/icon_alt.afphoto
Normal file
Binary file not shown.
BIN
res/logo_cooker_Final.afphoto
Normal file
BIN
res/logo_cooker_Final.afphoto
Normal file
Binary file not shown.
BIN
res/logo_stacked_merged.afphoto
Normal file
BIN
res/logo_stacked_merged.afphoto
Normal file
Binary file not shown.
13
res/logo_stacked_merged.svg
Normal file
13
res/logo_stacked_merged.svg
Normal file
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 31 KiB |
BIN
res/logo_unstacked.afphoto
Normal file
BIN
res/logo_unstacked.afphoto
Normal file
Binary file not shown.
Loading…
Reference in a new issue