From 4f175d4481d3582be449d573b3c590d805720e16 Mon Sep 17 00:00:00 2001 From: laz Date: Tue, 4 Feb 2025 06:25:12 +0100 Subject: [PATCH] layout --- .../docs/wiki_general/supported-devices.md | 53 ++++++++++--------- wiki-rtd/mkdocs.yml | 27 +++++----- 2 files changed, 43 insertions(+), 37 deletions(-) diff --git a/wiki-rtd/docs/wiki_general/supported-devices.md b/wiki-rtd/docs/wiki_general/supported-devices.md index c08addf..bb7a059 100644 --- a/wiki-rtd/docs/wiki_general/supported-devices.md +++ b/wiki-rtd/docs/wiki_general/supported-devices.md @@ -1,41 +1,36 @@ -# What devices/systems does RetroDECK currently support? +# What devices and OS does RetroDECK currently support? -RetroDECK currently officially supports two systems: +RetroDECK currently only works on x86_64 architecture. -- Steam Deck -- Linux Desktop +## Steam Deck -## Steam Deck LCD/OLED - -RetroDECK was built for the Steam Deck in mind. - -### Other SteamOS devices - -SteamOS the operative system will always be supported but as of today there are no other officialy released devices with SteamOS other the Valve's Steam Deck lineup. +RetroDECK was built for the Steam Deck in mind and started as a project towards that device. ## Linux Desktop -It is working, but the user experience might not be that great it as we want it to be just yet. +It works, but RetroDECK is still reliant on Steam Input for advanced hotkeys. -You will also need to manually configure the input to match your desktop and might need to tweak more settings. +For the best experience we recommend a distribution that has built in Game Mode like Valves SteamOS, Bazzite, ChimeraOS and so forth. -If you want to try it make sure that your distribution has flatpak support (else you will need to install it). +Game Mode fixes several Steam issues that are present in standard Linux Desktop such as the radials are rendered correctly on screen. -### Will you support other Linux distribution methods such as Snap or AppImage? +## Other x86_64 Linux Handhelds / Devices -It's not in our roadmap yet as now the entire buildsystem is based on the flatpak-build that builds the software via the flatpak manifest. -In the past we evaluated to migrate to **Buildstream** (or similar solutions) and build on to multiple output formats. +Our community is highly creative and likes putting RetroDECK on new devices. -But the team is not large enough to migrate and maintain other distribution methods, so we prefer to focus our effort on Flatpak only. -If someone with knowledge and passion wishes to help us with migrating to a solution and help us maintain it, we are open for a discussion. +Many devices are emulating a Playstation, Steam Deck or Xbox controller this it should work out of the box and be able to hook into that corresponding Steam Input Layout. -### Putting Linux on Windows Gaming Device and running RetroDECK +If it does not show up as any known input, The RetroDECK Team might not have been able to create a input profile for a new device as it needs to be bought by the team to add it. -We have user confirmation that RetroDECK does work on the other handhelds. +If you own a device that has custom inputs and want to create a Steam Input profile for it, please get it touch with the Team and so we can ship it in a later update. -Our community is highly creative and likes putting RetroDECK on new things like Legion Go and ROG Ally. +### Installing Linux & RetroDECK on x86_64 Windows Handelds -## Will you support Windows? +We have user confirmation that RetroDECK does work on the other handhelds that was released with Windows. + +## FAQ Devices / OS + +### Will you support Windows? No, RetroDECK doesn't support Windows currently. @@ -48,7 +43,7 @@ It would be a major undertaking but maybe one day in the future it could be poss We would also need more developers with Windows experience to help us with this effort. -## Will you support ARM devices like iOS, MacOS and Android? +### Will you support ARM devices like iOS, MacOS and Android? No, RetroDECK doesn't support ARM devices currently. @@ -60,6 +55,14 @@ But it would need to be a unique experience as the emulators, other underlying s It is a vastly different landscape with other licensing models for several of the emulators/systems specially on Android where the X86_64 binary is FOSS while the Android version is closed source. -## Will you support RISC-V? +### Will you support RISC-V? The idea of a widely accepted open-source architecture is exiting at least. It would be a major undertaking but one day in the far-off future it could be possible as the platform matures and more systems gets compatibility. + +### Will you support other Linux distribution methods such as Snap or AppImage? + +It's not in our roadmap yet as now the entire buildsystem is based on the flatpak-build that builds the software via the flatpak manifest. +In the past we evaluated to migrate to **Buildstream** (or similar solutions) and build on to multiple output formats. + +But the team is not large enough to migrate and maintain other distribution methods, so we prefer to focus our effort on Flatpak only. +If someone with knowledge and passion wishes to help us with migrating to a solution and help us maintain it, we are open for a discussion. diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 77388f0..0d4ae18 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -68,19 +68,19 @@ nav: - Blog: - blog/index.md - - What is RetroDECK? ❔: wiki_about/what-is-retrodeck.md - - What is the story & goals behind RetroDECK?: wiki_about/story-goals.md - - Systems included in RetroDECK đŸ“Ļ: wiki_about/what-is-included.md - - Start using RetroDECK 🏎ī¸: wiki_general/retrodeck-start.md - - Add RetroDECK to Steam: wiki_general/add-to-steam.md - - Supported Devices đŸ“ē: wiki_general/supported-devices.md - - Supported Controllers 🕹ī¸: wiki_general/supported-controllers.md - - Change Controller Order: wiki_rd_controls/change-controller-order-steam.md - - Different Button Prompts in Games ❓: wiki_rd_controls/diffrent-game-inputs.md - - Version History 📁: wiki_rd_versions/version-history.md - - How to Contribute? ❤ī¸: wiki_community/contibute-rd.md - - Bugs & Known Issues 🐜: wiki_bugs/known-issues.md + - Start using RetroDECK 🏎ī¸: wiki_general/retrodeck-start.md + + - About RetroDECK đŸ“Ļ: + + - What is RetroDECK?: wiki_about/what-is-retrodeck.md + - What is the story & goals behind RetroDECK?: wiki_about/story-goals.md + - Systems included in RetroDECK: wiki_about/what-is-included.md + - Supported Devices & OS: wiki_general/supported-devices.md + - Supported Controllers: wiki_general/supported-controllers.md + - How to Contribute?: wiki_community/contibute-rd.md + - Bugs & Known Issues: wiki_bugs/known-issues.md + - Version History: wiki_rd_versions/version-history.md - FAQ ❔: @@ -92,6 +92,8 @@ nav: - Guides - RetroDECK Controls & Hotkeys 🎮: - RetroDECK & Udev Rules: wiki_rd_controls/about-udev.md + - Different Button Prompts in Games: wiki_rd_controls/diffrent-game-inputs.md + - Change Controller Order: wiki_rd_controls/change-controller-order-steam.md - Generic Standard - Hotkeys & Layout: wiki_rd_controls/hotkeys-generic-standard.md - Nintendo - Hotkeys & Layout: wiki_rd_controls/hotkeys-nintendo.md - Playstation - Hotkeys & Layout: wiki_rd_controls/hotkeys-playstation.md @@ -108,6 +110,7 @@ nav: - Guides - Files & Game Management 📂: + - Add RetroDECK to Steam: wiki_general/add-to-steam.md - Game Compability Lists: wiki_management/compatibility-lists.md - Manage your BIOS/Firmware: wiki_management/bios-firmware.md - Manage your Multidisk/file games: wiki_management/multi-disk.md