mirror of
https://github.com/RetroDECK/Wiki.git
synced 2025-04-10 19:15:16 +00:00
more guides
This commit is contained in:
laz
parent
bfa48d9596
commit
11b502ba69
wiki-rtd
|
|
@ -37,11 +37,10 @@ Run the following command:
|
|||
9. Go to `🎮 Controller Settings` -> `Controller Layouts` -> `Templates` and enable the template for the controller you are using.
|
||||
10. Launch RetroDECK and enjoy!
|
||||
|
||||
## Updates
|
||||
## Other Tips
|
||||
|
||||
Updates to RetroDECK are handled automatically via your software manager when a new version is released. To update from the terminal, type:
|
||||
|
||||
`flatpak update`
|
||||
- Check on: [How-to: Update RetroDECK](../../wiki_management/retrodeck-update.md).
|
||||
- If you no longer want RetroDECK, you can find the removal guide at: [How-to: Remove RetroDECK](../../wiki_management/retrodeck-remove.md).
|
||||
|
||||
## Game Mode on Your Linux PC?
|
||||
|
||||
|
|
|
|||
|
|
@ -21,11 +21,6 @@ Depending on what language you have set in `Desktop Mode`, things might be named
|
|||
- Read up on the [RetroDECK: Steam Deck - Hotkeys](../../wiki_rd_controls/hotkeys-steamdeck-neptune.md).
|
||||
- Launch RetroDECK and Enjoy!
|
||||
|
||||
**Other Quick Tips:**
|
||||
|
||||
- Explore our other software recommendations for the Steam Deck: [Steam Deck: Software Recommendations](../../wiki_devices/steamdeck/steamdeck-software.md).
|
||||
- Check various optional optimizations that can make some systems run even better: [Steam Deck: Optimizations](../../wiki_devices/steamdeck/steamdeck-optimize.md).
|
||||
|
||||
## Step-by-Step Guide to Install RetroDECK on the Steam Deck
|
||||
|
||||
### Step 1: Go to Desktop Mode
|
||||
|
|
@ -46,7 +41,6 @@ Put the Steam Deck into `Desktop Mode`:
|
|||
|
||||
- Read the guide on: [How-to: Add RetroDECK to Steam](../../wiki_management/add-to-steam.md).
|
||||
- Add BIOS and ROMs: Put the BIOS files inside `retrodeck/bios/` and ROMs & game files inside `retrodeck/roms/`. If you are unsure how to add ROMs and BIOS to RetroDECK [RetroDECK: Start Using](../../wiki_general/retrodeck-start.md).
|
||||
|
||||
- After this, you can see RetroDECK in Steam Deck's `Game Mode` after returning from `Desktop Mode`.
|
||||
|
||||
### Step 4: Configure the Steam Controller Profiles
|
||||
|
|
@ -59,23 +53,9 @@ This step is only needed if you installed the profiles. If you missed installing
|
|||
- Add one of the layouts for RetroDECK called `RetroDECK: Steam Deck - Neptune` SIMPLE or FULL.
|
||||
- Read up on the [RetroDECK: Steam Deck - Hotkeys](../../wiki_rd_controls/hotkeys-steamdeck-neptune.md).
|
||||
|
||||
**Other quick tips**
|
||||
## Other Tips
|
||||
|
||||
- Explore our other software recommendations for the Steam Deck: [Steam Deck: Software Recommendations](../../wiki_devices/steamdeck/steamdeck-software.md).
|
||||
- Check various optional optimizations that can make some systems run even better: [Steam Deck: Optimizations](../../wiki_devices/steamdeck/steamdeck-optimize.md).
|
||||
|
||||
## How-to: Update RetroDECK on the Steam Deck
|
||||
|
||||
|
||||
- Put the Steam Deck into `Desktop Mode`: `Steam button` -> `Power` -> `Switch to Desktop`.
|
||||
- Open the Discover application.
|
||||
- Click on the updates tab.
|
||||
- If there are any updates available, they will be shown here.
|
||||
- Click on the `Update` or `Update all` button.
|
||||
|
||||
### Decky: AutoFlatpaks
|
||||
|
||||
If you have Decky installed and the AutoFlatpaks plugin, you can update RetroDECK from `Game Mode`.
|
||||
|
||||
Read more here: [Steam Deck: Software Recommendations](../../wiki_devices/steamdeck/steamdeck-software.md).
|
||||
|
||||
- Check on: [How-to: Update RetroDECK](../../wiki_management/retrodeck-update.md).
|
||||
- If you no longer want RetroDECK, you can find the removal guide at: [How-to: Remove RetroDECK](../../wiki_management/retrodeck-remove.md).
|
||||
|
|
|
|||
|
|
@ -1,155 +1,53 @@
|
|||
# FAQ: RetroDECK - Usage Questions
|
||||
|
||||
|
||||
|
||||
<img src="../../wiki_icons/retrodeck/rd_icon_circle_192x192.png">
|
||||
|
||||
## What to Use: Saves or States?
|
||||
|
||||
Always use in-game saves and treat states as a backup. States from older emulator versions might not work with updates, so don't rely solely on them.
|
||||
|
||||
## What to use? In the game Saves or States?
|
||||
## Do I Need to Partition or Format My Disk/SD Card for RetroDECK?
|
||||
|
||||
Always use in-game saves and treat the states as a compliment to the main save. As emulators update with new versions, states of old versions could be incompatible and simply not work. Never rely only on states!
|
||||
No, RetroDECK installs as a flatpak. Just install it like any other app and launch it from your desktop or Steam library.
|
||||
|
||||
## Where is RetroDECK Installed?
|
||||
|
||||
`~/retrodeck`: Contains user data like ROMs, mods, and themes. This folder is not deleted during uninstallation.
|
||||
|
||||
## Do I have to partition or format my disk/sdcard to install RetroDECK?
|
||||
`~/.var/app/net.retrodeck.retrodeck`: Contains the core flatpak, emulators, and settings. This folder is removed during uninstallation.
|
||||
|
||||
No, partitioning or formatting is not needed at all. RetroDECK (differently from AmberELEC, Batocera and others) comes as a flatpak. Just install it as any other application and launch it from your desktop and/or Steam library.
|
||||
## Can I Move the RetroDECK Folders?
|
||||
|
||||
## Where is RetroDECK installed?
|
||||
Yes, you can move it using the RetroDECK Configurator's "Move Tools".
|
||||
|
||||
There are two primary folders:
|
||||
Read more on: [RetroDECK Configurator 🛠️](../wiki_system_guides/configurator/configurator.md)
|
||||
|
||||
`~/retrodeck`
|
||||
|
||||
- The location of this folder is where you set it during installation.
|
||||
|
||||
- This contains all the user data that the users put into RetroDECK like ROMs, Mods, Texturepacks, Downloaded Content, Themes etc.
|
||||
|
||||
- The folder is not deleted during an uninstallation of RetroDECK and must be manually deleted, as all the users valuble files are there.
|
||||
|
||||
`~/.var/app/net.retrodeck.retrodeck/`
|
||||
|
||||
- This is the main flatpak folder, under the hidden `./var/app/` folder you need to show hidden folders and files to see it.
|
||||
|
||||
- This contains all the emulators, emulationstation and other settings that make RetroDECK work.
|
||||
|
||||
- During uninstallation, this folder is removed.
|
||||
|
||||
|
||||
|
||||
## Can I move the ROMs folder to another place?
|
||||
|
||||
Yes, you can do so inside the configurator and the `Move RetroDECK` option.
|
||||
|
||||
|
||||
|
||||
## Is there a way to reset RetroDECK?
|
||||
## Is There a Way to Reset RetroDECK?
|
||||
|
||||
Yes, you can reset various parts of the software using the RetroDECK Configurator's reset functions.
|
||||
|
||||
Read more on: [RetroDECK Configurator 🛠️](../wiki_system_guides/configurator/configurator.md)
|
||||
|
||||
|
||||
|
||||
## How do I uninstall RetroDECK?
|
||||
|
||||
On the Steam Deck first put itinto Desktop Mode `Steam button` `Power` `Switch to Desktop`
|
||||
|
||||
* Go into Discover or you software manager.
|
||||
|
||||
* Press the `Installed` tab and find RetroDECK
|
||||
|
||||
* Press the `Uninstall` button
|
||||
|
||||
* Manually backup then remove the `~\retrodeck` folder. Warning! Make a backup of your data roms/bios/saves etc if you want to save them else, they will be gone.
|
||||
|
||||
|
||||
## Does uninstalling RetroDECK remove my roms, bios and saves/states?
|
||||
|
||||
No, if you do not manually delete the `~\retrodeck` folder and its content your data is safe. You could uninstall RetroDECK and install it again and keep going.
|
||||
|
||||
|
||||
|
||||
## How can I move RetroDECK to a different device like Steam Deck OLED or a new Linux PC?
|
||||
|
||||
Yes, check over at [How to: Move RetroDECK to a new device](../wiki_management/retrodeck-move.md)
|
||||
|
||||
|
||||
|
||||
## Where can I find the logfiles?
|
||||
|
||||
In `~/retrodeck/.logs/retrodeck.log`
|
||||
|
||||
|
||||
|
||||
## Can I add a single game to my Steam Library?
|
||||
|
||||
We are working on this feature. Meanwhile you can achieve this manually.
|
||||
|
||||
Example of a launch script to launch to launch a Wii game called Baloon World:
|
||||
|
||||
|
||||
```
|
||||
|
||||
flatpak run --command=dolphin-emu-wrapper net.retrodeck.retrodeck -e "/run/media/mmcblk0p1/retrodeck/roms/wii/Baloon World.rvz" -b
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## After installing RetroDECK manually, Discover is not opening or giving me some errors?
|
||||
|
||||
This bug appears only when installing RetroDECK manually and not from Discover. The discover release is suggested for all the users.
|
||||
However, you can run this to fix it: `flatpak remote-delete retrodeck-origin`
|
||||
|
||||
|
||||
|
||||
## I disabled Steam Input from RetroDECK in Steam and now controls do not work anymore.
|
||||
|
||||
RetroDECK is using Steam Input so for all the controller profiles disabling it is not recommend. If you can not enable Steam Input again and the Steam GUI is buggy you have to do this:
|
||||
|
||||
1. Remove RetroDECK as `A Non-Steam Game` from the `Library`
|
||||
2. Add it again via `Library` - `Add a Non-Steam Game to My Library` (or use BoilR).
|
||||
|
||||
|
||||
|
||||
## How do I update RetroDECK?
|
||||
|
||||
Updates to RetroDECK are handled automatically via your distributions software manager when there is an updated version released like KDE's Discover or Gnome Software.
|
||||
On the Steam Deck you can also install the AutoFlatpaks plugin for Decky to be able to update in gamemode.
|
||||
|
||||
If you want to update from the terminal, you can type:
|
||||
|
||||
`flatpak update`
|
||||
|
||||
|
||||
|
||||
### I have not updated RetroDECK for a very very long time, can I safely update?
|
||||
|
||||
It is always recommended to keep RetroDECK updated.
|
||||
|
||||
But if you have not updated in very long time (a year or more) it might be better to just uninstall and reinstall RetroDECK from your software manager instead of doing the upgrade, as it can take longer.
|
||||
|
||||
If you are even several major versions behind (example: going from 0.4b to 0.8b) we recommend uninstalling and reinstalling.
|
||||
|
||||
## How do I update a specific emulator in RetroDECK?
|
||||
|
||||
You cannot in a straightforward way do that without breaking several things. RetroDECK builds many emulators and adds RetroDECK specific features on top of them and makes it into one application as is the goal of the project.
|
||||
|
||||
But that said we are looking into allowing a limited scope of custom emulator installation for those that have early access versions that are payed like Yuzu and the users really want to add in.
|
||||
|
||||
The custom installation will still be more limited than the one we ship with RetroDECK by default and might have less features than normal Yuzu in term of hotkey support and other things that the user will need to configure manually.
|
||||
|
||||
## Do you only ship stable versions of the emulators or nightly versions?
|
||||
|
||||
RetroDECK ships with the version that is the best for running the games on a case-by-case basis.
|
||||
|
||||
For all bleeding edge emulators like Yuzu or RPCS3 it's nightly version we ship.
|
||||
|
||||
But for things like RetroArch it is only the stable release of the application we ship. When it comes to RetroArch Cores they always use their stable version, but if there is no stable version of a core within a stable release of RetroArch the nightly version of that core will be used instead.
|
||||
|
||||
Even before we release a new update for RetroDECK the nightly versions of the emulators will be tested to make sure they work, and no serious issues are known to exist in them.
|
||||
There have been instances where the nightly version of an emulator has been completely broken and we want to avoid shipping that with RetroDECK.
|
||||
## How Do I Uninstall RetroDECK?
|
||||
|
||||
- **Optional Steam Deck Step** Switch to Desktop Mode: `Steam button` -> `Power` -> `Switch to Desktop`
|
||||
- Open Discover or your software manager.
|
||||
- Go to the Installed tab, find RetroDECK, and press Uninstall.
|
||||
|
||||
### Does Uninstalling RetroDECK Remove User Data: ROMs, BIOS, Saves/States, etc?
|
||||
|
||||
No, you need to manually delete the `retrodeck/` folder to remove these files.
|
||||
|
||||
## How do I move RetroDECK to a New Device?
|
||||
|
||||
Check the guide at: [How-to Move RetroDECK to a New Device](../wiki_management/retrodeck-move.md)
|
||||
|
||||
## Where to Find Logfiles?
|
||||
|
||||
You can find the logfiles in the `retrodeck/.logs/` folder.
|
||||
|
||||
## Does RetroDECK ship with Stable or Nightly Versions of Systems?
|
||||
|
||||
RetroDECK ships with the best version for running games. For bleeding-edge emulators like RPCS3, it ships nightly versions. For RetroArch, it ships stable releases, but uses nightly versions of cores if no stable version exists.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# How do I move RetroDECK to a new device
|
||||
|
||||
<img src="../../wiki_icons/pixelitos/folder-blue-sync.png" width="50">
|
||||
<img src="../../wiki_icons/pixelitos/system-switch-user.png" width="75">
|
||||
|
||||
## Information on moving RetroDECK
|
||||
|
||||
|
|
|
|||
13
wiki-rtd/docs/wiki_management/retrodeck-remove.md
Normal file
13
wiki-rtd/docs/wiki_management/retrodeck-remove.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# How-to: Uninstall RetroDECK
|
||||
|
||||
<img src="../../wiki_icons/pixelitos/system-shutdown.png" width="75">
|
||||
|
||||
## How Do I Uninstall RetroDECK?
|
||||
|
||||
- **Optional Steam Deck Step** Switch to Desktop Mode: `Steam button` -> `Power` -> `Switch to Desktop`
|
||||
- Open Discover or your software manager.
|
||||
- Go to the Installed tab, find RetroDECK, and press Uninstall.
|
||||
|
||||
### Question - Does Uninstalling RetroDECK Remove User Data: ROMs, BIOS, Saves/States, etc?
|
||||
|
||||
No, you need to manually delete the `retrodeck/` folder to remove these files.
|
||||
35
wiki-rtd/docs/wiki_management/retrodeck-update.md
Normal file
35
wiki-rtd/docs/wiki_management/retrodeck-update.md
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
# How-to: Update RetroDECK
|
||||
|
||||
<img src="../../wiki_icons/pixelitos/folder-blue-sync.png" width="75">
|
||||
|
||||
There are several ways to update RetroDECK.
|
||||
|
||||
## Software Manager (Recommended)
|
||||
|
||||
Updates are handled automatically via your distribution's software manager.
|
||||
|
||||
- **Optional Steam Deck Step** Switch to `Desktop Mode`: `Steam button` -> `Power` -> `Switch to Desktop`.
|
||||
- Open the Discover or your software manager.
|
||||
- Click on the updates tab.
|
||||
- If there are any updates available, they will be shown here.
|
||||
- Click on the `Update` or `Update all` button.
|
||||
|
||||
## Terminal
|
||||
|
||||
Type, `flatpak update -y` to update all installed flatpaks.
|
||||
|
||||
## Steam Deck - Decky: AutoFlatpaks
|
||||
|
||||
If you have Decky installed and the AutoFlatpaks plugin, you can update RetroDECK from there via `Game Mode`.
|
||||
|
||||
Read more here: [Steam Deck: Software Recommendations](../wiki_devices/steamdeck/steamdeck-software.md).
|
||||
|
||||
## Questions
|
||||
|
||||
### Updating After a Long Time?
|
||||
|
||||
If you haven't updated RetroDECK for a very long time (a year or more), it's better to uninstall and reinstall it from your software manager instead of upgrading.
|
||||
|
||||
### Updating Specific Systems in RetroDECK?
|
||||
|
||||
You cannot update specific systems directly in RetroDECK. You will need to wait for new versions of RetroDECK to be released.
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Please note that we are going to rebuild the Configurator into a controller friendly GODOT application and that the current version is not the final design.**
|
||||
|
||||
<img src="../../wiki_images/graphics/configurator/configurator.png" width="500">
|
||||
<img src="../../../wiki_images/graphics/configurator/configurator.png" width="500">
|
||||
|
||||
The `RetroDECK Configurator` is a unique multi-use utility that exists within RetroDECK to manage many aspects of the application and exposes functions from the `RetroDECK Framework` to the user.
|
||||
|
||||
|
|
@ -10,11 +10,11 @@ The `RetroDECK Configurator` can be opened from:
|
|||
|
||||
- The main menu inside the ES-DE interface and choose `RetroDECK Configurator`.
|
||||
|
||||
<img src="../../wiki_images/graphics/configurator/configurator-esde.png" width="500">
|
||||
<img src="../../../wiki_images/graphics/configurator/configurator-esde.png" width="500">
|
||||
|
||||
* From the `RetroDECK Configurator.desktop` desktop shortcut, available in your application menu.
|
||||
|
||||
<img src="../../wiki_images/graphics/configurator/configurator-kde.png" width="500">
|
||||
<img src="../../../wiki_images/graphics/configurator/configurator-kde.png" width="500">
|
||||
|
||||
* From CLI by calling `flatpak run net.retrodeck.retrodeck --configurator`
|
||||
|
||||
|
|
@ -198,6 +198,6 @@ This enables or disables the Steam Sync feature.
|
|||
|
||||
Read more here:
|
||||
|
||||
[SRM Guide](../../wiki_system_guides/srm/srm-guide.md)
|
||||
[SRM Guide](../../../wiki_system_guides/srm/srm-guide.md)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -104,16 +104,18 @@ nav:
|
|||
- RetroDECK - Simple Radial Menu: wiki_rd_controls/radial-simple.md
|
||||
- RetroDECK - Full Radial Menu: wiki_rd_controls/radial-steamdeck-full.md
|
||||
|
||||
- Guides - RetroDECK Configurator 🧰:
|
||||
- Guides - RetroDECK Management 🧰:
|
||||
|
||||
- Configurator Features: wiki_system_guides/configurator/configurator.md
|
||||
- RetroDECK Configurator: wiki_system_guides/configurator/configurator.md
|
||||
- Move RetroDECK to another Device: wiki_management/retrodeck-move.md
|
||||
- Update RetroDECK : wiki_management/retrodeck-update.md
|
||||
- Remove RetroDECK: wiki_management/retrodeck-remove.md
|
||||
|
||||
- Guides - Files & Game Management 📂:
|
||||
|
||||
- Add RetroDECK to Steam: wiki_management/add-to-steam.md
|
||||
- Manage your BIOS/Firmware: wiki_management/bios-firmware.md
|
||||
- Manage your Multidisk/file games: wiki_management/multi-disk.md
|
||||
- Move RetroDECK to a new device: wiki_management/retrodeck-move.md
|
||||
- ES-DE - General Guide: wiki_system_guides/es-de/esde-guide.md
|
||||
- Spreading Files over Multiple Drives: wiki_management/spread-files.md
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue