RetroDECK/wiki-rtd/docs/wiki_general/configurator.md

196 lines
5.1 KiB
Markdown
Raw Normal View History

2023-11-29 13:34:00 +00:00
# The RetroDECK Configurator
2023-12-04 07:12:06 +00:00
<img src="../../wiki_images/graphics/configurator/configurator.png" width="500">
2023-12-04 06:53:16 +00:00
The `RetroDECK Configurator` is a unique multi-use utility that exists within RetroDECK to manage many aspect of the application and exposes functions from the `RetroDECK Framework` to the user.
2023-11-29 13:34:00 +00:00
2023-12-04 06:51:19 +00:00
The `RetroDECK Configurator` can be opened from:
2023-11-29 13:34:00 +00:00
2023-12-04 07:18:30 +00:00
- The main menu inside the ES-DE interface and choose `RetroDECK Configurator`.
<img src="../../wiki_images/graphics/configurator/configurator-esde.png" width="500">
2023-12-02 13:03:57 +00:00
* From the `RetroDECK Configurator.desktop` desktop shortcut, available in your application menu.
2023-12-04 07:18:30 +00:00
<img src="../../wiki_images/graphics/configurator/configurator-kde.png" width="500">
2023-12-02 13:03:57 +00:00
* From CLI by calling `flatpak run net.retrodeck.retrodeck --configurator`
2023-11-29 13:34:00 +00:00
What follows are the commands you can use inside the Configurator (more commands will be added during development).
2023-12-04 07:18:30 +00:00
2023-11-29 13:34:00 +00:00
## Presets & Settings
In this menu you can set various presets.
### Global: Presets & Settings
In this menu you will find presets and settings that span over multiple emulators.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### RetroAchivements: Login
Login to RetroAchievements in all supported emulators and cores.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### RetroAchivements: Logut
Logut from RetroAchievements in all supported emulators and cores.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### RetroAchivements: Hardcore Mode
Enables `Hardcore Mode` from RetroAchievements in all supported emulators and cores.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### Widescreen: Enable/Disable
Enables or disable Widescreen in all supported emulators and cores.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### Swap A/B and X/Y: Enable/Disable
Swaps `A/B` `X/Y` in all supported emulators and cores.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### Ask to Exit prompt: Enable/Disable
Enables or disables ask to exit prompts in all supported emulators and cores.
Note: If you disable this, the emulators will directly exit.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### RetroArch: Presets & Settings
In this menu you will find presets and settings for RetroArch.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
2023-12-02 18:13:04 +00:00
#### Borders: Enable/Disable
2023-11-29 13:34:00 +00:00
Enable / Disable borders across the RetroArch cores you choose.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
2023-12-02 18:13:04 +00:00
#### Rewind: Enable/Disable
2023-11-29 13:34:00 +00:00
Enable / Disable rewind across all of RetroArch (this may impact performance on some more demanding systems).
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### Wii & Gamecube: Presets & Settings
In this menu you will find presets and settings for Dolphin and Primehack.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### Dolphin Textures: Universal Dynamic Input
Enable / Disable Venomalias's Universal Dynamic Input Texture for Dolphin.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### Primehack Textures: Universal Dynamic Input
Enable / Disable Venomalias's Universal Dynamic Input Texture for Primehack.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
## Open Emulator
Here you launch and configure each emulators settings, the option you choose will open that emulators GUI. For documentation on how to change the settings of each emulators settings please check the website of each emulator.
2023-12-02 13:03:57 +00:00
(Please note that most of the emulator interfaces where not designed with controller input in mind for handling the applications GUI, just the games. So you might need to use other inputs like the Steam Decks touchscreen or a mouse and key board to navigate properly).
2023-11-29 13:34:00 +00:00
2023-12-02 13:03:57 +00:00
From this entry you can run the emualtor itself such as:
2023-11-29 13:34:00 +00:00
2023-12-02 13:03:57 +00:00
- RetroArch
- Citra
- Dolphin
- Duckstation
- MelonDS
- PCSX2
- PPSSPP
- RPCS3
- XEMU
- Yuzu
2023-11-29 13:34:00 +00:00
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
## RetroDECK: Tools
### Tool: Move files
This option lets you choose the installation path of the RetroDECK folder that handles ROMS,Saves, BIOS etc... to a new location.
You get the following three options.
`Internal Storage` - Moves the folder to the internal storage. <br>
`SD CARD` - Moves the folder to the SD CARD <br>
`Custom Location` - Choose where you want the RetroDECK folder to be.<br>
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### Tool: Compress games
This option enables you to compress disc based game image files `.gdi` `.iso` `.bin` `.cue` to the less space demanding `.chd` format.
You can choose either a single game or many.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### Install: RetroDECK SD Controller Profile
This option installs the Steam Deck controller profile to RetroDECK it also resets all emulators configurations to input the correct bindings.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### Install: PS3 Firmware
2023-12-02 13:03:57 +00:00
This option downloads and installs the latest PS3 firmware. A the end of the download, RPCS3 will open requesting the user to install it. Just press OK.
2023-11-29 13:34:00 +00:00
2023-12-02 18:13:04 +00:00
<br>
2023-12-02 13:03:57 +00:00
### RetroDECK: Change update settings (cooker only)
2023-11-29 13:34:00 +00:00
This option lets you turn on or off automatic updates on launch.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
## RetroDECK: Troubleshooting
2023-12-02 18:13:04 +00:00
Various troubleshooting options.
2023-11-29 13:34:00 +00:00
### Backup: RetroDECK Userdata
Creates backups of the user data folders
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### Check & Verify: Multi-file structure
Verifies to the structure of multi disc/file games that uses `.m3u` files.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### Check & Verify: BIOS
Shows a detailed BIOS list of missing and current BIOS.
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### RetroDECK: Reset
The reset menu resets various features
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### Reset Specific Emulator
Opens up a menu where you can reset a specific emulator
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### Reset All Emulators
Resets all the emulators at once
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
#### Reset RetroDECK
2023-12-04 07:12:06 +00:00
Resets the entirety of RetroDECK.<br>
`⚠️ WARNING! BACK UP YOUR DATA BEFORE RUNNING THIS! ⚠️`
2023-11-29 13:34:00 +00:00
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
## RetroDECK: About
This menu contains information about RetroDECK
### Version history
Displays the changelogs
2023-12-02 18:13:04 +00:00
<br>
2023-11-29 13:34:00 +00:00
### Credits
Displays the credits