diff --git a/wiki-rtd/docs/index.md b/wiki-rtd/docs/index.md index 55ccf50..be58ef6 100644 --- a/wiki-rtd/docs/index.md +++ b/wiki-rtd/docs/index.md @@ -32,7 +32,7 @@ Those can either be: ## What devices and operating systems are supported? - [Supported Devices & OS](wiki_general/supported-devices.md) -- [Supported Controllers](wiki_general/supported-controllers.md) +- [Supported Controllers / Hotkeys](wiki_rd_controls/hotkeys-retrodeck.md) --- diff --git a/wiki-rtd/docs/wiki_about/what-is-included.md b/wiki-rtd/docs/wiki_about/what-is-included.md index fd6e3a4..18f8652 100644 --- a/wiki-rtd/docs/wiki_about/what-is-included.md +++ b/wiki-rtd/docs/wiki_about/what-is-included.md @@ -238,13 +238,13 @@ It adds separate games to Steam, adds artwork and configures the steam input pro [SRM - General Guide](../wiki_system_guides/srm/srm-guide.md) -## Steam Input Controller layouts +## Steam Input Controller Templates -For all inputs layouts included in RetroDECK. +For all Steam Inputs Templates included in RetroDECK. **Read more here:** -[Supported Controllers](../wiki_general/supported-controllers.md). +[Supported Controllers / Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md). ## Supported Devices diff --git a/wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md b/wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md index 3fbca28..458f926 100644 --- a/wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md +++ b/wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md @@ -23,7 +23,7 @@ Run the following command: `flatpak install Flathub net.retrodeck.retrodeck` -## First Run - Quick Start +## Quickstart Guide 1. Start RetroDECK for the first time 2. Choose where RetroDECK should create the main folder `retrodeck/`: `Internal Storage`, `SD Card` or `Custom Location`. @@ -31,7 +31,7 @@ Run the following command: 4. Put the ROMs & game files inside `retrodeck/roms/`. 5. Choose to install Steam Controller Templates for RetroDECK (this should be checked by default) during installation. 5. Add RetroDECK to Steam: [How-to: Add RetroDECK to Steam](../../wiki_management/add-to-steam.md). -6. Enable controller support in Steam: [How-to: Enable Controllers in Steam ](../../wiki_general/supported-controllers.md). +6. Enable controller support in Steam: [Supported Controllers / Hotkeys](../../wiki_rd_controls/hotkeys-retrodeck.md). 7. Connect your controller to your desktop. 8. Navigate to RetroDECK in Steam 9. Go to `๐ฎ Controller Settings` -> `Controller Layouts` -> `Templates` and enable the template for the controller you are using. diff --git a/wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md b/wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md index 2b2de9a..e3feaeb 100644 --- a/wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md +++ b/wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md @@ -6,7 +6,7 @@ Depending on what language you have set in `Desktop Mode`, things might be named differently. -## Quickstart guide +## Quickstart Guide - Switch to `Desktop Mode`: Press the `Steam button` -> `Power` -> `Switch to Desktop` - Install RetroDECK: Open the Discover application and search for RetroDECK. Press the install button. @@ -17,8 +17,8 @@ Depending on what language you have set in `Desktop Mode`, things might be named - **Optional** Get RetroDECK Steam Grid art and add it to your Steam library with BoilR, or add the art manually from [SteamgridDB](https://www.steamgriddb.com/search/grids?term=RetroDeck). - Add BIOS and ROMs: Put the BIOS files inside `retrodeck/bios/` and ROMs & game files inside `retrodeck/roms/`. - Switch back to `Game Mode`: Go to RetroDECK on the Steam Grid under `Library` -> `Non-Steam`. -- Configure Controller Layouts: Add the RetroDECK: `Steam Deck - Neptune Official Template` under `๐ฎ Controller Settings` -> `Controller Layouts` -> `Templates`. Choose either the SIMPLE radial layout or FULL radial layout. -- **Optional** If you have external controllers connected you can also apply those templates via `๐ฎ Controller Settings` -> `Controller Layouts` -> `Templates`. +- Configure Controller Layouts: Add the RetroDECK: `Steam Deck - Neptune Official Template` under `๐ฎ Controller Settings` -> `Controller Layouts` -> `Templates`. Choose either the SIMPLE radial layout or FULL radial layout. +- **Optional** If you have external controllers connected you can also apply those templates via `๐ฎ Controller Settings` -> `Controller Layouts` -> `Templates`. - Read up on the [RetroDECK: Controller Hotkeys](../../wiki_rd_controls/hotkeys-retrodeck.md).. - Launch RetroDECK and Enjoy! diff --git a/wiki-rtd/docs/wiki_general/supported-controllers.md b/wiki-rtd/docs/wiki_general/supported-controllers.md deleted file mode 100644 index 7520cf6..0000000 --- a/wiki-rtd/docs/wiki_general/supported-controllers.md +++ /dev/null @@ -1,68 +0,0 @@ -# RetroDECK - Supported Controllers - -<img src="../../wiki_icons/pixelitos/game-input.png" width="75"> - -## RetroDECK Controller Mapping - -RetroDECK uses Steam Input for advanced controller mapping. More controllers will be added as Steam Input supports them. - -### Customizing Controls - -- Rebind buttons in RetroDECK's Steam Input Templates and emulators. -- Create your own profile, but updates to Steam or RetroDECK might break it. -- If broken, revert to Official Controller Profiles or reinstall from the RetroDECK Configurator. - -## Prerequisites for Steam Input - -### Adding RetroDECK to Steam - -1. In Steam, go to the `Games` tab. -2. Press `Add non-Steam game to My library`. -3. Select RetroDECK. You can also add it manually or via software like `BoilR`. - -### Linux Desktop - steam-devices - -- The `steam-devices` package is usually part of the Steam installation for many distributions. -- Required for Steam to recognize controllers. -- Steam will warn you if `steam-devices` is missing. -- Check your distribution's instructions to install it if needed. - -**Note:** Not needed for SteamOS-based devices like the Steam Deck or most gaming distributions like Bazzite, Chimera, Nobara, and more. - -### Enable All Steam Input in Steam - -1. In Steam, press the `Steam` top menu. -2. Go to `Settings`. -3. Press `๐ฎ Controller`. -4. Enable all Steam Inputs for `Xbox`, `PlayStation`, `Switch Pro`, `Generic`. -5. Close the `Settings`. - -### Finding the Templates - -1. Select RetroDECK in Steam. -2. Go to `๐ฎ Controller Settings`. -3. Select `Controller Layouts`. -4. Choose `Templates`. - -**Note:** - -On Linux Desktop, connect an external controller via cable, Bluetooth, or wireless for the `๐ฎ Controller Settings` icon to show up. - -## Steam Input Templates - -What follows is a list with links of the currently supported Steam Input Templates. - - -| Controller | Template Name | Version | Original System | Controller Link | Hotkeys Link | Comment | -| :--- | :---: | :---: | :---: | :---: | :---: | :---: | -| Generic Standard | `RetroDECK: Generic - Standard` | `v.1b` | Varies |[Generic Standard](../wiki_controllers/generic/generic-standard.md)|[RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md) | Majority of 3rd Party Controllers with a Standard Layout | -| Switch Pro | `RetroDECK: Switch Pro` | `v.1b` | Nintendo Switch | [Switch Pro](../wiki_controllers/nintendo/switch-pro.md)|[RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md) | | -| Steam Deck: Neptune| `RetroDECK: Steam Deck - Neptune`| `v.1.1b` | Steam Deck LCD/OLED |[Steam Deck - Neptune](../wiki_controllers/steam/steamdeck-neptune.md) | [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| Has two radial menu systems | -| Steam Controller: Gordon | `RetroDECK: Steam Controller - Gordon` | `v.1b` | Steam Devices | [Steam Controller - Gordon](../wiki_controllers/steam/steam-controller-gordon.md) | [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| | -| DualShock 3 | `RetroDECK: DualShock 3` | `v.1b` | PlayStation 3 |[DualShock 3](../wiki_controllers/playstation/dualshock-3.md) | [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| | -| DualShock 4 | `RetroDECK: DualShock 4` | `v.1b` | PlayStation 4 |[DualShock 4](../wiki_controllers/playstation/dualshock-4.md) | [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| | -| DualSense | `RetroDECK: DualSense` | `v.1b` | PlayStation 5 |[DualSense](../wiki_controllers/playstation/dualsense.md)| [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| | -| DualSense Edge | `RetroDECK: Dualshock 3` | `v.1b` | PlayStation 5 | [DualSense Edge](../wiki_controllers/playstation/dualsense-edge.md) | [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| | -| Xbox 360 | `RetroDECK: Xbox 360` | `v.1b` | Xbox 360 | [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| | -| Xbox Wireless | `RetroDECK: Xbox Wireless` | `v.1b` | Xbox One / S / X | [Xbox 360 Controller](../wiki_controllers/xbox/xbox-360.md) | [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| | -| Xbox Elite Wireless Series 1 / 2 | `RetroDECK: Xbox Wireless` | `v.1b` | Xbox S / X | [Xbox Elite Wireless Controller Series 1 / 2](../wiki_controllers/xbox/xbox-wireless-elite.md) | [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)| Works as a normal Xbox Wireless in Steam Input | diff --git a/wiki-rtd/docs/wiki_images/steam/steam-controller-apply.png b/wiki-rtd/docs/wiki_images/steam/steam-controller-apply.png new file mode 100644 index 0000000..1005f8f Binary files /dev/null and b/wiki-rtd/docs/wiki_images/steam/steam-controller-apply.png differ diff --git a/wiki-rtd/docs/wiki_music/rd-what-will-happen/What will happen to RetroDECK?!.mp3 b/wiki-rtd/docs/wiki_music/rd-what-will-happen/What will happen to RetroDECK.mp3 similarity index 100% rename from wiki-rtd/docs/wiki_music/rd-what-will-happen/What will happen to RetroDECK?!.mp3 rename to wiki-rtd/docs/wiki_music/rd-what-will-happen/What will happen to RetroDECK.mp3 diff --git a/wiki-rtd/docs/wiki_music/rd-what-will-happen/what-will-happen.md b/wiki-rtd/docs/wiki_music/rd-what-will-happen/what-will-happen.md index 456f2f1..231a3fe 100644 --- a/wiki-rtd/docs/wiki_music/rd-what-will-happen/what-will-happen.md +++ b/wiki-rtd/docs/wiki_music/rd-what-will-happen/what-will-happen.md @@ -3,7 +3,7 @@ <img src="../thalin-the-troll.png" width="300"> - + ยฉ๏ธ Music Lyrics: Lazorne the Troll Hunter (โเฒ _เฒ )โๅฝกโปโโป ยฉ๏ธ Art: Thalin the Troll diff --git a/wiki-rtd/docs/wiki_rd_controls/hotkeys-retrodeck.md b/wiki-rtd/docs/wiki_rd_controls/hotkeys-retrodeck.md index 67eb3af..0adeb3c 100644 --- a/wiki-rtd/docs/wiki_rd_controls/hotkeys-retrodeck.md +++ b/wiki-rtd/docs/wiki_rd_controls/hotkeys-retrodeck.md @@ -1,20 +1,81 @@ # RetroDECK Hotkeys +## RetroDECK Controller Mapping + +RetroDECK uses Steam Input for advanced controller mapping. More controllers will be added as Steam Input supports them. + +### Customizing Controls + +- Rebind buttons in RetroDECK's Steam Input Templates and emulators. +- Create your own profile, but updates to Steam or RetroDECK might break it. +- If broken, revert to Official Controller Profiles or reinstall from the RetroDECK Configurator. + +--- + +## Prerequisites for Steam Input + +### Add RetroDECK to Steam + +Read more here: [How-to: Add RetroDECK to Steam](../wiki_management/add-to-steam.md) + +### Linux Desktop - steam-devices + +- The `steam-devices` package is usually part of the Steam installation for many distributions. +- Required for Steam to recognize controllers. +- Steam will warn you if `steam-devices` is missing. +- Check your distribution's instructions to install it if needed. + +**Note:** Not needed for SteamOS-based devices like the Steam Deck or most gaming distributions like Bazzite, Chimera, Nobara, and more. + +### Linux Desktop - Enable All Steam Input in Steam + +1. In Steam, press the `Steam` top menu. +2. Go to `Settings`. +3. Press `๐ฎ Controller`. +4. Enable all Steam Inputs for `Xbox`, `PlayStation`, `Switch Pro`, `Generic`. +5. Close the `Settings`. + +## Applying the Templates + +1. Select RetroDECK in Steam. +2. Press `๐ฎ` -> `๐ฎ Controller Settings` -> `Controller Layouts` -> `Templates`. + +**Steam Deck:** + +<img src="../../../wiki_images/steam/steam-controller-icon.png" width="50"> + +**Linux Desktop:** + +<img src="../../../wiki_images/steam/steam-controller-icon-bar.png" width="200"> + +On Linux Desktop, connect an external controller via cable, Bluetooth, or wireless for the `๐ฎ Controller Settings` icon to show up. + + +<img src="../../../wiki_images/steam/steam-templates.png" width="600"> + +--- + + ## RetroDECK: Steam Input Templates -RetroDECK ships with the following Steam Input Templates: +What follows is a list with links of the currently supported Steam Input Templates. -- **Generic "Standard" Controllers:** `RetroDECK: Generic - Standard` -- **Switch Pro Controller:** `RetroDECK: Switch Pro` -- **DualShock 3 / Sixaxis:** `RetroDECK: Dualshock 3` -- **DualShock 4:** `RetroDECK: Dualshock 4` -- **DualSense / DualSense Edge:** `RetroDECK: DualSense` -- **Steam Controller (Gordon):** `RetroDECK: Steam Controller - Gordon` -- **Steam Deck (Neptune):** `RetroDECK: Steam Deck - Neptune FULL` (default) & `RetroDECK: Steam Deck - Neptune SIMPLE` -- **Xbox 360 Controller:** `RetroDECK: Xbox 360` -- **Xbox Wireless Controller/Elite Series:** `RetroDECK: Xbox Wireless` -In Steam go to `๐ฎ Controller Settings` -> `Controller Layouts` -> `Templates` and enable the template for the controller you are using. +| Controller | Template Name | Version | Original System | Controller Link | Comment | +| :--- | :---: | :---: | :---: | :---: | :---: | +| Generic Standard | `RetroDECK: Generic - Standard` | `v.1b` | Varies |[Generic Standard](../wiki_controllers/generic/generic-standard.md)| Majority of 3rd Party Controllers with a Standard Layout | +| Switch Pro | `RetroDECK: Switch Pro` | `v.1b` | Nintendo Switch | [Switch Pro](../wiki_controllers/nintendo/switch-pro.md)| | +| Steam Deck: Neptune| `RetroDECK: Steam Deck - Neptune`| `v.1.1b` | Steam Deck LCD/OLED |[Steam Deck - Neptune](../wiki_controllers/steam/steamdeck-neptune.md) | Has two radial menu systems | +| Steam Controller: Gordon | `RetroDECK: Steam Controller - Gordon` | `v.1b` | Steam Devices | [Steam Controller - Gordon](../wiki_controllers/steam/steam-controller-gordon.md)| | +| DualShock 3 | `RetroDECK: DualShock 3` | `v.1b` | PlayStation 3 |[DualShock 3](../wiki_controllers/playstation/dualshock-3.md) | | +| DualShock 4 | `RetroDECK: DualShock 4` | `v.1b` | PlayStation 4 |[DualShock 4](../wiki_controllers/playstation/dualshock-4.md)| | +| DualSense | `RetroDECK: DualSense` | `v.1b` | PlayStation 5 |[DualSense](../wiki_controllers/playstation/dualsense.md)| | +| DualSense Edge | `RetroDECK: DualSense Edge` | `v.1b` | PlayStation 5 | [DualSense Edge](../wiki_controllers/playstation/dualsense-edge.md)| | +| Xbox 360 | `RetroDECK: Xbox 360` | `v.1b` | Xbox 360 | [Xbox 360 Controller](../wiki_controllers/xbox/xbox-360.md)| | +| Xbox Wireless | `RetroDECK: Xbox Wireless` | `v.1b` | Xbox One / S / X | [Xbox Wireless Controller](../wiki_controllers/xbox/xbox-wireless.md) | | +| Xbox Elite Wireless Series 1 / 2 | `RetroDECK: Xbox Wireless` | `v.1b` | Xbox S / X | [Xbox Elite Wireless Controller Series 1 / 2](../wiki_controllers/xbox/xbox-wireless-elite.md) | | + +--- ## The HotKey Button diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 8af55ff..b963718 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -77,7 +77,6 @@ nav: - What is systems are included in RetroDECK?: wiki_about/what-is-included.md - What is the Story Behind RetroDECK?: wiki_about/story-goals.md - Supported Devices & OS: wiki_general/supported-devices.md - - Supported Controllers: wiki_general/supported-controllers.md - Version History: wiki_rd_versions/version-history.md - Report a Problem & Known Issues: wiki_general/known-issues.md - How to Contribute?: wiki_about/contibute-retrodeck.md