diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..f81927b1 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,13 @@ +# These are supported funding model platforms + +#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: RetroDECK # Replace with a single Patreon username +#open_collective: # Replace with a single Open Collective username +#ko_fi: # Replace with a single Ko-fi username +#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +#liberapay: # Replace with a single Liberapay username +#issuehunt: # Replace with a single IssueHunt username +#otechie: # Replace with a single Otechie username +#lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +custom: ['https://retrodeck.readthedocs.io/en/latest/wiki_about/donations-licenses/'] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.gitignore b/.gitignore index fb057393..d2569309 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ backup .old tmp .godot +rd-submodules/es-de/patches-tmp* .local/ buildid *.bak @@ -30,4 +31,4 @@ __pycache__ rd-submodules/retroarch* rd-submodules/ryujinx* rd-submodules/shared-modules* -rd-submodules/es-de/patches-tmp* \ No newline at end of file +rd-submodules/es-de/patches-tmp* diff --git a/README.md b/README.md index 671a783d..88b3f7cb 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ # RetroDECK on your device! +

-screenshot -screenshot
screenshot screenshot

-
+ +Instead of having several different emulators, engines and frontends on your Linux/SteamOS system you only need one: RetroDECK. ![Flathub](https://img.shields.io/flathub/downloads/net.retrodeck.retrodeck) ![Flathub](https://img.shields.io/flathub/v/net.retrodeck.retrodeck) @@ -18,43 +18,21 @@ ![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 to have one: RetroDECK. +**The RetroDECK Wiki & FAQ** -RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered flatpak 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 one complete package. +Please check out the these links for even more information: -It's inspired by embedded emulation systems like: - -- AmberELEC -- EmuELEC -- CoreELEC -- Lakka -- Batocera - -The RetroDECK team consists of several veterans from some of the projects mentioned above as well as a bunch of other talented individuals. - -RetroDECK also adds the `RetroDECK Framework` and the `RetroDECK Configurator` on top of the emulators and ES-DE frontend 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. - -For our long term vision you can check out the following wiki page: - -[RetroDECK: Visions and Goals](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Visions-and-Goals) - -### The RetroDECK community: - -[Website](https://retrodeck.net)
-[Wiki](https://github.com/XargonWan/RetroDECK/wiki)
-[Discord](https://discord.gg/Dz3szYsP8g)
-[Lemmy](https://lemmy.zip/c/retrodeck)
-[Subreddit](https://www.reddit.com/r/retrodeck) +- [RetroDECK Wiki](https://retrodeck.readthedocs.io/en/latest/) +- [RetroDECK FAQ](https://retrodeck.readthedocs.io/en/latest/wiki_general/faq/) # How do I start using RetroDECK? +Basically just download it from Flathub, put your roms/games and needed bioses and just play. -We have an in depth How To on how to get started over here: +Read our getting started guide here: -[How to: Start using RetroDECK](https://github.com/XargonWan/RetroDECK/wiki/How-to%3A-Start-using-RetroDECK) +[How to: Start using RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_general/retrodeck-start/) ## What devices/systems does RetroDECK support: - RetroDECK currently supports: - Steam Deck @@ -62,21 +40,58 @@ RetroDECK currently supports: For more information read up here: -[Supported Systems](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Supported-Systems) +[Supported Systems](https://retrodeck.readthedocs.io/en/latest/wiki_general/supported-devices/) + +## What is RetroDECK? +RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered Linux [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. + +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. -## Is RetroDECK in Beta? +### 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/) + +### How to get support? +Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g) `🤝-community-support` and `🆘-support`. +### The RetroDECK community: +[Website](https://retrodeck.net)
+[Wiki](https://github.com/XargonWan/RetroDECK/wiki)
+[Discord](https://discord.gg/Dz3szYsP8g)
+[Lemmy](https://lemmy.zip/c/retrodeck)
+[Subreddit](https://www.reddit.com/r/retrodeck) + +### Is RetroDECK in Beta? Yes, here you can read more about the beta period: -[RetroDECK: Beta period](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Beta-period) - - -## Can I contribute to the project? +[RetroDECK: Beta period](https://retrodeck.readthedocs.io/en/latest/wiki_general/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](https://github.com/XargonWan/RetroDECK/wiki/How-to%3A-Contribute-to-RetroDECK) +[How to: Contribute to RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_community/contibute-rd/) ## Our repositories: | Name | Description | diff --git a/automation_tools/install_dependencies.sh b/automation_tools/install_dependencies.sh index e4cc6261..8f33f8cb 100755 --- a/automation_tools/install_dependencies.sh +++ b/automation_tools/install_dependencies.sh @@ -2,4 +2,5 @@ # This scritp is installing the required dependencies to correctly run the pipeline and buold the flatpak sudo apt install -y flatpak flatpak-builder p7zip-full xmlstarlet bzip2 curl -flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo \ No newline at end of file +flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo +flatpak remote-add --user --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo \ No newline at end of file diff --git a/docs/wiki/steamdeck/layout/graphics/DS - Menu.png b/docs/wiki/steamdeck/layout/graphics/DS - Menu.png deleted file mode 100644 index 2d54213a..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/DS - Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/Disp_Graph_Menu.png b/docs/wiki/steamdeck/layout/graphics/Disp_Graph_Menu.png deleted file mode 100644 index 73684ea6..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/Disp_Graph_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/Emu_Spec_Menu.png b/docs/wiki/steamdeck/layout/graphics/Emu_Spec_Menu.png deleted file mode 100644 index 9015a072..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/Emu_Spec_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/GC_Wii_Menu.png b/docs/wiki/steamdeck/layout/graphics/GC_Wii_Menu.png deleted file mode 100644 index 1d1598af..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/GC_Wii_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/General_Menu.png b/docs/wiki/steamdeck/layout/graphics/General_Menu.png deleted file mode 100644 index 6ea53822..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/General_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/MAME_Menu.png b/docs/wiki/steamdeck/layout/graphics/MAME_Menu.png deleted file mode 100644 index 93287a4f..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/MAME_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/Main_Menu.png b/docs/wiki/steamdeck/layout/graphics/Main_Menu.png deleted file mode 100644 index bbf43d03..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/Main_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/Quick_Menu.png b/docs/wiki/steamdeck/layout/graphics/Quick_Menu.png deleted file mode 100644 index fb09918e..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/Quick_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/RetroArch_ Menu.png b/docs/wiki/steamdeck/layout/graphics/RetroArch_ Menu.png deleted file mode 100644 index 3d5ec715..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/RetroArch_ Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/Speed_Menu.png b/docs/wiki/steamdeck/layout/graphics/Speed_Menu.png deleted file mode 100644 index e86c48e2..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/Speed_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/State_Menu.png b/docs/wiki/steamdeck/layout/graphics/State_Menu.png deleted file mode 100644 index 1e363ac8..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/State_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/SteamDeck_Menu.png b/docs/wiki/steamdeck/layout/graphics/SteamDeck_Menu.png deleted file mode 100644 index 49026c9c..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/SteamDeck_Menu.png and /dev/null differ diff --git a/docs/wiki/steamdeck/layout/graphics/Switch_Menu.png b/docs/wiki/steamdeck/layout/graphics/Switch_Menu.png deleted file mode 100644 index 1e2acd0f..00000000 Binary files a/docs/wiki/steamdeck/layout/graphics/Switch_Menu.png and /dev/null differ diff --git a/functions/functions.sh b/functions/functions.sh index 8178fad0..d3349f33 100644 --- a/functions/functions.sh +++ b/functions/functions.sh @@ -498,7 +498,7 @@ install_retrodeck_controller_profile() { # USAGE: install_retrodeck_controller_profile if [[ -d "$HOME/.steam/steam/tenfoot/resource/images/library/controller/binding_icons/" && -d "$HOME/.steam/steam/controller_base/templates/" ]]; then rsync -rlD --mkpath "/app/retrodeck/binding_icons/" "$HOME/.steam/steam/tenfoot/resource/images/library/controller/binding_icons/" - cp -f "$emuconfigs/defaults/retrodeck/controller_configs/*.vdf" "$HOME/.steam/steam/controller_base/templates" + rsync -rlD --mkpath "$emuconfigs/defaults/retrodeck/controller_configs/" "$HOME/.steam/steam/controller_base/templates/" else configurator_generic_dialog "RetroDECK Controller Profile Install" "The target directories for the controller profile do not exist.\n\nThis may happen if you do not have Steam installed or the location is does not have permission to be read." fi diff --git a/net.retrodeck.retrodeck.appdata.xml b/net.retrodeck.retrodeck.appdata.xml index 341ac17c..325c0574 100644 --- a/net.retrodeck.retrodeck.appdata.xml +++ b/net.retrodeck.retrodeck.appdata.xml @@ -107,6 +107,23 @@ + + https://github.com/XargonWan/RetroDECK/releases/tag/0.7.6b + +

Changes:

+ +

Known issues:

+ + https://github.com/XargonWan/RetroDECK/releases/tag/0.7.5b @@ -752,4 +769,4 @@ - \ No newline at end of file + diff --git a/rd-submodules/retroarch b/rd-submodules/retroarch index a9682176..51d4821a 160000 --- a/rd-submodules/retroarch +++ b/rd-submodules/retroarch @@ -1 +1 @@ -Subproject commit a96821769848a711db1ed0b71883f91383e2b4ab +Subproject commit 51d4821a45ac5fe13b2baa69aaaea864ead407ce diff --git a/rd-submodules/ryujinx b/rd-submodules/ryujinx index f9e0cd83..ebcd7d1c 160000 --- a/rd-submodules/ryujinx +++ b/rd-submodules/ryujinx @@ -1 +1 @@ -Subproject commit f9e0cd83f366025c15de7de46621963cab793ea9 +Subproject commit ebcd7d1c9bbb2d4857555238727a81e89f6600f1 diff --git a/rd-submodules/shared-modules b/rd-submodules/shared-modules index 55a8e460..6ba63f38 160000 --- a/rd-submodules/shared-modules +++ b/rd-submodules/shared-modules @@ -1 +1 @@ -Subproject commit 55a8e460c6343229597a13e973ba4855c27a1c4c +Subproject commit 6ba63f383ad54e7ebe2b0cda64c15602cf9a9153 diff --git a/retrodeck.sh b/retrodeck.sh index daeb3cc8..254d383f 100644 --- a/retrodeck.sh +++ b/retrodeck.sh @@ -189,6 +189,12 @@ if [[ $update_check == "true" ]]; then fi fi +# THIS IS A ONE-OFF FORCED REFRESH OF RETRODECK CONTROLLER PROFILES IN A 0.7.6b VERSION REFRESH - REMOVE BEFORE NEXT VERSION RELEASE +if [[ -f "$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_config.vdf" ]]; then # If RetroDECK controller profile has been previously installed + install_retrodeck_controller_profile +fi +# REMOVE BEFORE NEXT VERSION RELEASE + # Normal Startup start_retrodeck