steamdeck

wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md

@@ -0,0 +1,46 @@
+# How do I install RetroDECK on the Linux Desktop?
+
+## Prerequisites
+
+1. You need to have flatpak support installed on your Linux desktop. <br>
+Follow the official flatpak guides on how to install it for your distribution:<br>
+https://flatpak.org/setup/
+
+2. We recommend that you have the `steam-devices` and/or `game-devices-udev` package installed as it comes with udev rules for many different controllers. You will have to check your distribution on how to install it.
+
+3. We currently recommend that you add and launch RetroDECK from Steam so you can utilize the Steam Input feature to change various aspects of the external controllers. We will be looking into other alternative solutions later for those that don't want to use Steam.
+
+# Installation
+
+## From the Desktop GUI
+
+- Go into your flatpak supported software manager in your desktop environment, this is different depending on what desktop you use. Example: for GNOME is often `GNOME Software` and for KDE it is `KDE Discover`.
+- Search for RetroDECK and press install.
+
+## From the terminal
+
+- Run the following command `flatpak install flathub net.retrodeck.retrodeck`
+
+
+# First Run - Quick Start
+
+- Start RetroDECK for the first time
+- Choose where RetroDECK should create the `roms` folders `Internal`, `SDCard` or `Custom`.
+- Put the BIOS inside `~/retrodeck/bios/` for more information read: [[Emulators: BIOS and Firmware]]
+- Put the ROMS inside `~/retrodeck/roms/` folder.
+- Add RetroDECK to Steam with  `Add non Steam game to My library` or with the software BoilR (Recommended).
+You can follow a more in depth guide here: [[Linux Desktop: Add RetroDECK to Steam]].
+- In Steam go to the `Settings` tab to go into the `Steam Settings`, press `Controller`, enable all Steam Inputs.  You can follow a more in depth guide here: [[Linux Desktop: Enable Controllers in Steam]]
+- Connect your controller to your Desktop.
+- Launch RetroDECK from Steam and enjoy
+
+### Other quick tips:
+- Read up on the [[EmulationStation DE: User Guide]]
+- Check out other recommended software [[Linux Desktop: Software recommendations]]
+
+# Updates
+
+Updates to RetroDECK is handled automatically via your software manager when there is a new version released.
+
+Or if you want to update from the terminal you can type: <br>
+`flatpak update`

wiki-rtd/docs/wiki_devices/linux_desktop/linux-software.md

@@ -0,0 +1,39 @@
+# Any other recommended software?
+
+The following software works great with the Linux Desktop and might enhance your RetroDECK experience (these are entirely optional to install).
+
+## Flips
+Flips is a software that let you patch romhacks IPS & BPS files onto the rom files.
+It's already on flathub.
+
+_Made by Alcaro_
+
+[Flips](https://flathub.org/apps/details/com.github.Alcaro.Flips)
+
+## BoilR
+
+BoilR will show games from other games platforms in your Steam library. It uses the Steam 3rd party shortcuts feature and does not require you to set up anything. You can also use BoilR to manually and automatically download custom art from SteamGridDB. It's already in flathub.
+
+_Made by Philipk_
+
+[BoilR](https://flathub.org/apps/details/io.github.philipk.boilr)
+
+## JRomManager
+A Mame and Retrogaming Rom Manager. <br>
+This more complex application allows you to manage and verify your roms via .dat files. It's already in on flathub and downloadable in Discover.
+
+_Made by optyfr_
+
+[JRomManager](https://flathub.org/apps/details/com.github.optyfr.JRomManager)<br>
+
+## RomM
+RomM is a game library roms manager focused in retro gaming. Manage and organize all of your games from a web browser.
+Inspired by [Jellyfin](https://jellyfin.org/), allows you to manage all your games from a modern interface while enriching them with IGDB metadata.
+
+_Made by zurdi15_
+
+[RomM](https://github.com/zurdi15/romm)
+
+
+
+

wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-optimize.md

@@ -0,0 +1,61 @@
+# What are some optimizations for the Steam Deck to make emulation even better?
+These optimizations are entirely optional and but they can give you better performance on some more demanding emulators.
+
+## Increase the VRAM to 4GB
+This increases the VRAM to 4GB in the BIOS, this can give you improvements in certain emulators.
+
+* Power off your Steam Deck completely
+* Hold the `Power Button` and `Volume Up Button` until you hear a chime/beep and release the buttons.
+* Click on `Setup Utility`
+* Click on `Advanced`
+* Change`UMA Frame buffer Size` to 4GB
+* Save and Exit
+
+## Setup a sudo password
+This is a requirement for many optimizations and solutions, it also makes your Deck safer.
+It enables you to run commands/applications heighten sudo privileges.
+
+* Go to `Desktop Mode`
+* Open `Konsole` or another `Terminal`
+* Type `passwd`
+* You will now set your new sudo password
+* After you are done you can close the terminal
+
+## Install CryoUtilities
+This requires that you have set up a sudo password.
+
+This will create a 16GB SWAP file that can improve the performance for some emulators. Note that it will take up that extra space on your Steam Deck.
+
+* Go to `Desktop Mode`
+* Open a web browser and go to the [CryoUtilities](https://github.com/CryoByte33/steam-deck-utilities) github page
+* Click on releases
+* Download the latewst `cryo_utilities` version and save to the Desktop or Home folder
+* Double click on the file and it will begin the installation
+* After installation is complete you will find a new desktop icon `CryoUtilities`
+* Click on `CryoUtilities`
+* Click on `Recommended Settings`
+* It should now be done
+
+## Install Decky Loader
+Decky Loader is a [homebrew plugin store](https://beta.deckbrew.xyz/) for the Steam Deck.
+This requires that you have set up a sudo password.
+
+* Go to `Desktop Mode`
+* Open `Konsole` or another `Terminal`
+* Type `curl -L https://github.com/SteamDeckHomebrew/decky-installer/releases/latest/download/install_release.sh | sh`
+* Decky Loader should now be installed and you can go back into `Game Mode`.
+* To access Decky Loader you only need to press the `Menu Button - (•••)`
+
+### Decky Loader: Install Power Tools
+Power Tools allows you to tweak various performance settings of the Steam Deck.
+What the best setting is differs per emulator or even per game.
+Decky Loader is a requirement.
+
+In Game Mode:
+* `Menu Button - (•••)`
+*  Go into Decky Loader
+*  From the Store install Power Tools
+*  This will add a 🔌 icon to the `Menu Button - (•••)` where you can access Power Tools.
+
+
+

wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-software.md

@@ -0,0 +1,42 @@
+# Steam Deck specific recommendations
+The following software works great with the Steam Deck and might enhance your RetroDECK experience.
+For general Linux Desktop recommendations go to [Linux Desktop: Software recommendations](https://github.com/XargonWan/RetroDECK/wiki/Linux-Desktop:-Software-recommendations) as many of them also work on the Steam Deck.
+
+## CryoUtilities
+Scripts and utilities to improve performance and manage storage on the Steam Deck.
+
+_Made by CryoByte33_
+
+[CryoUtilities link](https://github.com/CryoByte33/steam-deck-utilities)
+
+## Discover Overlay
+If you use Discord this is a program that adds Discord integration into the Steam Deck's gamemode UI.
+It's already in on flathub and downloadable in Discover. Note that you need to install and login to Discord as well.
+
+_Made by trigg_
+
+[Discover Overlay Link](https://trigg.github.io/Discover/)
+
+
+## Decky Loader
+Is a great piece of software that allows custom plugins inside Steam Deck's gamemode. It can open up more advanced features then the standard Steam Deck experience offers. But it's a bit more technical to install, please follow the guide on their github.
+
+_Made by Steam Deck Homebrew Team_
+
+[Decky Loader Link](https://github.com/SteamDeckHomebrew/decky-loader)
+
+
+### Plugin: PowerTools
+PowerTools let's you do advanced tweaking of the Steam Decks hardware. This can greatly improve performance on certain games in the PS2,GC and above generations. But it requires you to find the knowledge of what setting works best for each game and/or emulator.
+
+_Made by NGnius_
+
+[PowerTools Link](https://github.com/NGnius/PowerTools)
+
+
+### Plugin: AutoFlatpaks
+AutoFlatpaks let's you update/install/manage flatpaks directly from gamemode. You can for example update RetroDECK directly from gamemode.
+
+_Made by jurassicplayer_
+
+[AutoFlatpaks Link](https://github.com/jurassicplayer/decky-autoflatpaks)

wiki-rtd/docs/wiki_faq_guide/add-to-steam.md

@@ -0,0 +1,77 @@
+# Adding RetroDECK to Steam
+What follows are two ways to add RetroDECK to Steam and what settings you need to enable after you added it. If you have the Flatpak Version of Steam installed you need to do some extra steps for everything to work.
+
+## Add with BoilR (Recommended)
+
+If you don't have [BoilR](https://flathub.org/apps/io.github.philipk.boilr) you can just install it from Flathub.
+BoilR will add RetroDECK to Steam (flatpak or standard versions), it will also add the Steam Grid art.
+
+First make sure that you have fully closed Steam then do the following:
+
+1. Open BoilR
+2. Make sure RetroDECK is marked in the `Import Games` Section
+3. Go to `Settings`
+4. Check `Download Images`
+5. Put in your `Authentication Key` from `SteamGridDB` (if you don't have one press the link in BoilR and get one).
+6. Check if you want animated images or other types of images.
+7. Go back to `Import Games`.
+8. Press the `Import Button`.
+9. When the import is done you can close BoilR and Open Steam.
+10. The RetroDECK entry should now be there
+
+## Add manually
+
+1. Open Steam
+2. Inside Steam go to the tab Games press `Add non Steam game to My library` and you should be able to see all installed applications select `RetroDECK` to add it into your library.
+3. Go to SteamGridDB and manually download all the art.
+4. Follow the guides on SteamGridDB on how to set up each art piece correctly.
+
+## Steam - Flatpak version extras
+
+If you have the [Steam Flatpak](https://flathub.org/apps/com.valvesoftware.Steam) version installed some extra steps apply.
+
+### Prerequisites
+
+To make a flatpak launch other flatpaks it needs a special permission called `org.freedesktop.Flatpak`.
+Take note that this opens up the Flatpak more then normal, as flatpaks are not allowed to run many system commands from the sandbox. You can add the permission from the software Flatseal or directly from the terminal.
+
+**With Flatseal (Recommended):**
+
+If you don't have [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal) you can just install it from Flathub
+
+1. Open Flatseal
+2. Click on Steam
+3. Scroll down to the section called `Session Bus`
+4. Press the `+` sign
+5. Paste in `org.freedesktop.Flatpak`
+6. Launch Steam
+
+**From Terminal:**
+
+Copy the following into the terminal:
+
+`flatpak --user override --talk-name=org.freedesktop.Flatpak com.valvesoftware.Steam`
+
+### Add RetroDECK to Steam
+
+Add RetroDECK to Steam with BoilR or manually by following the guides above.
+
+**Special notes on the manual install:**
+
+Steam won't find the application directlyy and you will need to manually browse to the desktop file to add it in:
+
+`/var/lib/flatpak/app/net.retrodeck.retrodeck/current/active/export/share/applications/`
+
+### Configuring RetroDECK in Steam Flatpak
+
+After RetroDECK is added to Steam, right click on the RetroDECK entry and change the shortcut values to:
+
+**Target:**
+
+`/usr/bin/flatpak-spawn`
+
+**Launch options:**
+
+`--host flatpak run --branch=stable --arch=x86_64 net.retrodeck.retrodeck`
+
+This should now be enough for you to launch RetroDECK.

wiki-rtd/docs/wiki_faq_guide/enable-controllers-steam.md

@@ -0,0 +1,44 @@
+# Enable Controllers in Steam:
+
+**Not needed for SteamOS and Steam Deck**<br>
+For the Steam Deck or SteamOS based devices this is not needed as they are enabled by default.
+
+## Prerequisites: steam-devices
+
+Make sure you have installed the `steam-devices` package.
+
+Normally `steam-devices` is a part of the Steam installation for many distrubtions, but it could be diffrent depending on what you are running.
+
+Steam usually complains with warnings if `steam-devices` is missing.
+
+If `steam-devices` is not installed, please check your distrubtion on how to do so.
+
+## Enable Controller Inputs
+
+Open up Steam
+
+1. In Steam press the `Steam` top menu
+2. Go to `Settings` this opens up S
+4. Press `Controller`
+5. Press and enable all Steam Inputs for:
+* Xbox Controllers.
+* PlayStation Controllers.
+* Switch Pro Controllers.
+* Generic Controllers.
+6. Close the `Settings`
+
+## Change controller templates in Steam
+
+### Prerequisites
+
+* You need to have enabled controller input in Steam (above).
+* You need to have added RetroDECK to Steam, more info here: [Add RetroDECK to Steam](/wiki_faq_guide/add-to-steam/)
+* You need to have the controller or controllers plugged in / connected for the `Controller Icon` to show up next to the Cog icon in each game and
+
+### Controller Settings
+
+1. Click on RetroDECK in Steam
+2. Make sure you have a controller plugged in / connected
+3. Click on the new `Controller Icon 🎮` next to the ⚙️ icon on the right side of the Steam window.
+4. By pressing on it you will open the `Steam Input` window wher you can customize the controllers inputs / download community templates / enable the RetroDECK templates for your controller.
+5. Read more information here: [RetroDECK with Steam Input](/wiki_controllers/about-steam-input/) and the `Controllers and Input 🎮` section on this wiki.

wiki-rtd/mkdocs.yml

@@ -14,9 +14,17 @@ nav:
   - FAQ and Guides ❔:
     - FAQ - Frequently Asked Questions: wiki_faq_guide/faq.md
     - Move RetroDECK to a new device: wiki_faq_guide/move-retrodeck.md
+    - Add RetroDECK to Steam: wiki_faq_guide/add-to-steam.md
+    - Enable Controllers in Steam: wiki_faq_guide/enable-controllers-steam.md
 
   - Steam Deck:
-    - Install RetroDECK on Steam Deck: wiki_devices/steamdeck/steamdeck-start.md
+    - Steam Deck - Installation and Updates: wiki_devices/steamdeck/steamdeck-start.md
+    - Steam Deck - Optimizations: wiki_devices/steamdeck/steamdeck-optimize.md
+    - Steam Deck - Software Recommendations: wiki_devices/steamdeck/steamdeck-software.md
+
+  - Linux Desktop:
+    - Linux Desktop - Installation and Updates: wiki_devices/linux_desktop/linux-install.md
+    - Linux Desktop - Software Recommendations: wiki_devices/linux_desktop/linux-software.md
 
   - Controllers and Input 🎮:
     - RetroDECK with Steam Input: wiki_controllers/about-steam-input.md