Wiki/wiki-rtd/docs/wiki_system_guides/configurator/configurator.md

202 lines
5 KiB
Markdown
Raw Normal View History

2025-02-09 11:04:29 +00:00
# RetroDECK Configurator
2025-02-10 16:59:23 +00:00
<img src="../../../wiki_icons/retrodeck/icon-configurator.svg" width="100">
2024-01-06 08:25:02 +00:00
2024-07-20 08:03:22 +00:00
**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.**
2024-01-06 08:25:02 +00:00
2025-02-09 11:04:29 +00:00
## Information
2025-03-23 11:43:12 +00:00
<img src="../classic-configurator.png" width="800">
2024-01-06 08:25:02 +00:00
2024-02-24 11:31:27 +00:00
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.
2024-01-06 08:25:02 +00:00
The `RetroDECK Configurator` can be opened from:
- The main menu inside the ES-DE interface and choose `RetroDECK Configurator`.
2025-03-23 11:43:12 +00:00
<img src="../configurator-esde.png" width="500">
2024-01-06 08:25:02 +00:00
* From the `RetroDECK Configurator.desktop` desktop shortcut, available in your application menu.
2025-03-23 11:43:12 +00:00
<img src="../configurator-kde.png" width="500">
2024-01-06 08:25:02 +00:00
* From CLI by calling `flatpak run net.retrodeck.retrodeck --configurator`
What follows are the commands you can use inside the Configurator (more commands will be added during development).
2025-02-27 08:17:03 +00:00
## Settings
2025-01-24 09:55:03 +00:00
2025-03-23 11:43:12 +00:00
<img src="../classic-configurator-settings.png" width="800">
2025-03-01 18:18:37 +00:00
2025-02-27 08:17:03 +00:00
In this menu you can set various settings.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Borders
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
Enable / Disable borders across the RetroArch cores you choose.
### Widescreen
Enable / Disable Widescreen in all supported emulators and cores.
2024-05-20 05:26:46 +00:00
2025-02-27 08:17:03 +00:00
### Ask-to-Exit
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
Enable / Disable Ask-to-Exit prompts in all supported emulators and cores.
2025-01-24 09:55:03 +00:00
If you disable this, the emulators will directly exit.
2024-05-20 05:26:46 +00:00
2025-02-27 08:17:03 +00:00
### Rewind
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
Enable / Disable rewind across of RetroArch (this may impact performance on some more demanding systems).
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### RetroAchivements: Login
2025-01-24 09:55:03 +00:00
2024-01-06 08:25:02 +00:00
Login to RetroAchievements in all supported emulators and cores.
2025-02-27 08:17:03 +00:00
### RetroAchivements: Logut
2025-01-24 09:55:03 +00:00
2024-01-06 08:25:02 +00:00
Logut from RetroAchievements in all supported emulators and cores.
2025-02-27 08:17:03 +00:00
### RetroAchivements: Hardcore Mode
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
Enable / Disable `Hardcore Mode` from RetroAchievements in all supported emulators and cores.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Swap A/B and X/Y
2025-01-24 09:55:03 +00:00
2024-05-20 05:26:46 +00:00
Swaps `A/B` `X/Y` in supported emulators and cores.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Quick Resume
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
Enable / Disable `Quick Resume` aka `Auto Save` + `Auto Load` on exit in supported emulators and cores.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Universal Dynamic Input: Dolphin
2025-01-24 09:55:03 +00:00
2024-01-06 08:25:02 +00:00
Enable / Disable Venomalias's Universal Dynamic Input Texture for Dolphin.
2025-02-27 08:17:03 +00:00
### Universal Dynamic Input: Primehack
2024-01-06 08:25:02 +00:00
2025-01-24 09:55:03 +00:00
Enable / Disable Venomalias's Universal Dynamic Input Texture for Primehack.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### PortMaster: Hide
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
Enable / Disable the PortMaster entry in ES-DE.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
## Open Component
2024-01-06 08:25:02 +00:00
2025-03-23 11:43:12 +00:00
<img src="../classic-configurator-open.png" width="800">
2025-03-01 18:18:37 +00:00
2025-02-27 08:17:03 +00:00
Launch and configure each components settings. The chosen option opens the components GUI.
2024-07-20 08:03:22 +00:00
2025-02-27 08:17:03 +00:00
The Components are all:
2024-07-20 08:03:22 +00:00
2025-02-27 08:17:03 +00:00
- Emulators
- Systems
- Engines
2024-07-20 08:03:22 +00:00
2025-02-27 08:17:03 +00:00
Shipped with RetroDECK.
2024-07-20 08:03:22 +00:00
2025-02-27 08:17:03 +00:00
**Steam Deck Note:**
2024-02-24 11:31:27 +00:00
2025-02-27 08:17:03 +00:00
Most component interfaces are not designed for controller input for the GUI. You may need to use the Steam Deck's touchscreen or a mouse and keyboard.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
## Reset Component
2025-01-24 09:55:03 +00:00
2025-03-23 11:43:12 +00:00
<img src="../classic-configurator-reset.png" width="800">
2025-03-01 18:18:37 +00:00
2025-02-27 08:17:03 +00:00
This menu allows you to reset various components in RetroDECK or reset the entire application to its default settings. There is also a factory reset option.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
## Tools
2024-02-24 11:31:27 +00:00
2025-03-23 11:43:12 +00:00
<img src="../classic-configurator-tools.png" width="800">
2025-03-01 18:18:37 +00:00
2025-02-27 08:17:03 +00:00
### Backup Userdata
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
Creates backups of the user data folders
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### BIOS Checker
2024-02-24 11:31:27 +00:00
2025-02-27 08:17:03 +00:00
Launches the `BIOS Checker` tool that scans for needed BIOS files.
2024-01-06 08:25:02 +00:00
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
### Games Compressor
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
Launches the `Games Compressor` tool that compresses games into smaller formats.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
You can compress into:
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
- CHD
- ZIP
- RVZ
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
You can choose to compress one game or many.
2024-02-24 11:31:27 +00:00
2025-02-27 08:17:03 +00:00
### Install: RetroDECK Controller Layouts
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
This option installs the RetroDECK Steam Input Controller Templates into Steam.
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
### Install: PS3 Firmware
2024-02-24 11:31:27 +00:00
2025-02-27 08:17:03 +00:00
This option downloads and installs the latest PS3 firmware. After the download, RPCS3 will prompt you to install it.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Install: PS Vita Firmware
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
This option downloads and installs the latest PS Vita firmware.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Update Notification
2024-02-24 11:31:27 +00:00
2025-02-27 08:17:03 +00:00
Enable / Disable the Update Notification for new RetroDECK versions.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Add RetroDECK to Steam
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
A tool that adds RetroDECK to Steam with Art.
2024-02-24 11:31:27 +00:00
2025-03-01 18:23:18 +00:00
### M3U Multi-File Validator
2024-01-06 08:25:02 +00:00
2025-02-27 08:58:25 +00:00
A tool that checks the validity of `.m3u` files.
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
## Steam Sync
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
This enables or disables the Steam Sync feature.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
Read more here:
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
[SRM Guide](../srm/srm-guide.md)
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
## Data Mangement
2024-02-24 11:31:27 +00:00
2025-03-23 11:43:12 +00:00
<img src="../classic-configurator-data.png" width="800">
2025-03-01 18:18:37 +00:00
2025-02-27 08:17:03 +00:00
### Move Tools
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
Several move tools allow you to move specific folders to a new location.
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
`Internal Storage` - Moves the folder to the internal storage.
`SD CARD` - Moves the folder to the SD CARD
`Custom Location` - Choose where you want the RetroDECK folder to be.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Clean Empty ROM Folders
2024-02-24 11:31:27 +00:00
2025-02-27 08:17:03 +00:00
This tool removes some or all the ROM folders under `retrodeck/roms/` that are empty, leaving only those populated with content.
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
### Rebuild All ROM Folders
2024-01-06 08:25:02 +00:00
2025-02-27 08:17:03 +00:00
This tool rebuilds ROM folders you have accidentally removed or used the `Clean Empty ROM Folders` tool.
2024-02-24 11:31:27 +00:00
2025-02-27 08:17:03 +00:00
## About RetroDECK
2024-01-06 08:25:02 +00:00
2025-03-23 11:43:12 +00:00
<img src="../classic-configurator-about.png" width="800">
2025-03-01 18:18:37 +00:00
2024-01-06 08:25:02 +00:00
### Credits
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
Displays Credits.
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
### Version History
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
Menu for Patch Notes.
2025-01-24 09:55:03 +00:00
2025-02-27 08:17:03 +00:00
(Note: The patch notes are always more detailed on the wiki due to character limits during publication.)
2025-01-24 09:55:03 +00:00