Xargon/Wiki
1
0
Fork 0
mirror of https://github.com/RetroDECK/Wiki.git synced 2025-04-10 19:15:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

external

Browse source
This commit is contained in:
laz 2025-02-19 06:34:30 +01:00
parent f6a6d5164c
commit 745f5dc4e1
2 changed files with 45 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md
View file

@ -4,13 +4,31 @@
## Prerequisites ## Prerequisites
1. Ensure you have flatpak support installed on your Linux desktop. Follow the official flatpak guides for your distribution: [Flatpak Setup Guide](https://flatpak.org/setup/). **NOTE:** It's recommended to add and launch RetroDECK via Steam to utilize the Steam Input feature for external controllers.
2. Install the `steam-device` package for udev rules for various controllers (most gaming focused distribution have this already). Check your distribution's instructions for how to install it. ### Flatpak Support
3. It's recommended to add and launch RetroDECK from Steam to utilize the Steam Input feature for external controllers.
## RetroDECK Installation Ensure you have flatpak support installed on your Linux desktop. Follow the official flatpak guides for your distribution: [Flatpak Setup Guide](https://flatpak.org/setup/).
### Steam - 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.
### Steam - 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`.
## How-to: Install RetroDECK from Flathub
**From the Desktop** **From the Desktop**
@ -23,19 +41,17 @@ Run the following command:
`flatpak install Flathub net.retrodeck.retrodeck` `flatpak install Flathub net.retrodeck.retrodeck`
## Quickstart Guide ## How-to: Setup RetroDECK
1. Start RetroDECK for the first time 1. Start RetroDECK for the first time.
2. Choose where RetroDECK should create the main folder `retrodeck/`: `Internal Storage`, `SD Card` or `Custom Location`. 2. Choose where RetroDECK should create the main folder `retrodeck/`: `Internal Storage`, `SD Card` or `Custom Location`.
3. Put the BIOS files inside `retrodeck/bios/`. 3. Put the BIOS files inside `retrodeck/bios/`.
4. Put the ROMs & game files inside `retrodeck/roms/`. 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. 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. Add RetroDECK to Steam: [How-to: Add RetroDECK to Steam](../../wiki_management/add-to-steam.md).
6. Enable controller support in Steam: [Supported Controllers / Hotkeys](../../wiki_rd_controls/hotkeys-retrodeck.md). 7. Connect your controller to your desktop and navigate to RetroDECK in Steam.
7. Connect your controller to your desktop. 8. Apply controller Templates in Steam: [Supported Controllers / Hotkeys](../../wiki_rd_controls/hotkeys-retrodeck.md).
8. Navigate to RetroDECK in Steam 9. Launch RetroDECK and enjoy!
9. Go to `🎮 Controller Settings` -> `Controller Layouts` -> `Templates` and enable the template for the controller you are using.
10. Launch RetroDECK and enjoy!
## Other Tips ## Other Tips

52
wiki-rtd/docs/wiki_rd_controls/hotkeys-retrodeck.md
View file

@ -18,23 +18,6 @@ RetroDECK uses Steam Input for advanced controller mapping. More controllers wil
Read more here: [How-to: Add RetroDECK to Steam](../wiki_management/add-to-steam.md) 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 ## Applying the Templates
1. Select RetroDECK in Steam. 1. Select RetroDECK in Steam.
@ -48,36 +31,35 @@ Read more here: [How-to: Add RetroDECK to Steam](../wiki_management/add-to-steam
<img src="../../../wiki_images/steam/steam-controller-icon-bar.png" width="200"> <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. On Linux Desktop, connect an external controller via cable, Bluetooth, or wireless for the `🎮` icon to show up.
<img src="../../../wiki_images/steam/steam-templates.png" width="600"> <img src="../../../wiki_images/steam/steam-templates.png" width="600">
--- ---
## RetroDECK: Steam Input Templates ## RetroDECK: Steam Input Templates & HotKey Button
What follows is a list with links of the currently supported 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 | Comment | | Controller | Template Name | Version | Original System | Controller Link | HotKey Button (HKB) | 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 | | Generic Standard | `RetroDECK: Generic - Standard` | `v.1b` | Varies |[Generic Standard](../wiki_controllers/generic/generic-standard.md)|`Select` | 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)| | | Switch Pro | `RetroDECK: Switch Pro` | `v.1b` | Nintendo Switch | [Switch Pro](../wiki_controllers/nintendo/switch-pro.md)| `Minus` | |
| 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 Deck: Neptune| `RetroDECK: Steam Deck - Neptune`| `v.1.1b` | Steam Deck LCD/OLED |[Steam Deck - Neptune](../wiki_controllers/steam/steamdeck-neptune.md) |`L4` `R4` `Select` | 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)| | | Steam Controller: Gordon | `RetroDECK: Steam Controller - Gordon` | `v.1b` | Steam Devices | [Steam Controller - Gordon](../wiki_controllers/steam/steam-controller-gordon.md)| `L4` `Select` | |
| DualShock 3 | `RetroDECK: DualShock 3` | `v.1b` | PlayStation 3 |[DualShock 3](../wiki_controllers/playstation/dualshock-3.md) | | | DualShock 3 | `RetroDECK: DualShock 3` | `v.1b` | PlayStation 3 |[DualShock 3](../wiki_controllers/playstation/dualshock-3.md) |`Select` | |
| DualShock 4 | `RetroDECK: DualShock 4` | `v.1b` | PlayStation 4 |[DualShock 4](../wiki_controllers/playstation/dualshock-4.md)| | | DualShock 4 | `RetroDECK: DualShock 4` | `v.1b` | PlayStation 4 |[DualShock 4](../wiki_controllers/playstation/dualshock-4.md)|`Select` | |
| DualSense | `RetroDECK: DualSense` | `v.1b` | PlayStation 5 |[DualSense](../wiki_controllers/playstation/dualsense.md)| | | DualSense | `RetroDECK: DualSense` | `v.1b` | PlayStation 5 |[DualSense](../wiki_controllers/playstation/dualsense.md)|`Select` | |
| DualSense Edge | `RetroDECK: DualSense Edge` | `v.1b` | PlayStation 5 | [DualSense Edge](../wiki_controllers/playstation/dualsense-edge.md)| | | DualSense Edge | `RetroDECK: DualSense Edge` | `v.1b` | PlayStation 5 | [DualSense Edge](../wiki_controllers/playstation/dualsense-edge.md)|`Select` | |
| Xbox 360 | `RetroDECK: Xbox 360` | `v.1b` | Xbox 360 | [Xbox 360 Controller](../wiki_controllers/xbox/xbox-360.md)| | | Xbox 360 | `RetroDECK: Xbox 360` | `v.1b` | Xbox 360 | [Xbox 360 Controller](../wiki_controllers/xbox/xbox-360.md)| `Select`| |
| Xbox Wireless | `RetroDECK: Xbox Wireless` | `v.1b` | Xbox One / S / X | [Xbox Wireless Controller](../wiki_controllers/xbox/xbox-wireless.md) | | | Xbox Wireless | `RetroDECK: Xbox Wireless` | `v.1b` | Xbox One / S / X | [Xbox Wireless Controller](../wiki_controllers/xbox/xbox-wireless.md) | `Select` | |
| 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) | | | 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) |`Select` | |
--- ---
## The HotKey Button ### The HotKey Button
The global hotkeys are activated by pressing and holding the `HKB` (HotKey Button) and pressing the corresponding button together for the command you want to execute. The global hotkeys are activated by pressing and holding the `HKB` (HotKey Button) and pressing the corresponding button together for the command you want to execute.
@ -99,7 +81,7 @@ To execute the `Pause / Resume` command:
--- ---
## Hotkey list ## RetroDECK: Hotkey list
- **Function**: Shows what the hotkey does. - **Function**: Shows what the hotkey does.
- **Icon**: Shows the icon of the corresponding function in the radial menus. - **Icon**: Shows the icon of the corresponding function in the radial menus.