Configurator

wiki-rtd/docs/wiki_development/cli-guide.md

@@ -0,0 +1,79 @@
+# How do I run RetroDECK CLI commands?
+
+Open a Linux terminal on your desktop (on the Steam Deck you need to be in desktop mode). Depending on what terminal application you have installed the naming of the application can be different.<br>
+
+In Linux distributions that uses KDE desktop environment as well as the Steam Deck; the default application is called _Konsole_.
+<br>
+The default command to run retrodeck options and arguments is:
+
+`flatpak run [FLATPAK-RUN-OPTION] net.retrodeck.retrodeck [ARGUMENTS]`
+
+Where `[FLATPAK-RUN-OPTION]` is replaced by a flatpak run option (if there is one) and `[ARGUMENTS]` is replaced by arguments.
+
+**Example:**
+
+This syntax runs the `--reset-all` argument that resets the application to default settings.
+
+`flatpak run net.retrodeck-retrodeck --reset-all`
+
+Where the argument `--reset-all` replaced `[ARGUMENTS]` and `[FLATPAK-RUN-OPTION]`was not needed to it was removed.
+
+# CLI argument list
+
+`-h` or `--help` - Prints all the available arguments.
+
+`-v` or `--version` - Prints the installed RetroDECK version
+
+`--info-msg` - Prints all the folder paths and various config information.
+
+`--configurator` - Starts the RetroDECK configurator
+
+`--compress` - Compresses a specific file to .chd format. It supports .cue .iso and .gdi formats. You need to add the filepath to the file for it to work.
+
+`--reset-emulator` - Opens a new input where you can input an argument to reset a specific emulator or all emulators to the default settings. Inside the prompt you can type one of the following options to reset it;
+
+`all-emulators`
+`retroarch`
+`citra`
+`dolphin`
+`duckstation`
+`melonds`
+`pcsx2`
+`ppsspp`
+`primehack`
+`rpcs3`
+`xemu`
+`yuzu`
+
+`--reset-retrodeck` - Resets the entirety of RetroDECK to default settings!
+<br>
+⚠️ WARNING! BACK UP YOUR DATA BEFORE RUNNING THIS ARGUMENT! ⚠️
+
+# General flatpak commands
+
+If you want to check RetroDECK's flathub page [click here](https://flathub.org/apps/details/net.retrodeck.retrodeck)<br>
+Here follows some general flatpak commands that could be useful: <br>
+
+
+## Install RetroDECK from CLI
+
+If you want to install RetroDECK from CLI type:<br>
+`flatpak install flathub net.retrodeck.retrodeck`
+
+NOTE! This will work on the Steam Deck out of the box.<br>
+But on the Linux desktop you need to check your distribution if it ships with both Flatpak and Flathub integration installed, if not you may need to install it. Check your distributions or flathubs documentation on how to install it on your desktop.
+
+## Update all flatpaks from CLI
+
+If you want to update all installed flatpaks from CLI type:<br>
+`flatpak update`
+
+Then answer `y` on the input prompt.
+
+## Update only RetroDECK from CLI
+
+If you just want to update RetroDECK type: <br>
+
+`flatpak update net.retrodeck.retrodeck`
+
+Then answer `y` on the input prompt.

wiki-rtd/docs/wiki_development/folders-filepaths.md

@@ -0,0 +1,79 @@
+# What are the various folders and filepaths in RetroDECK?
+
+RetroDECK is a Flatpak a sandboxed bundle of different applications and configurations. One part of the files are none writable while others are.
+
+## `~/retrodeck`
+It's the home folder of RetroDECK itself, it contains:
+- `bios`, the bios folder, the actual `retroarch/system` folder is poiting here `~/.var/app/net.retrodeck.retrodeck/config/emulationstation/.emulationstation/downloaded_media` is pointing here
+- `.downloaded_media`, this is where you scraped data is saved (images, videos, logos..),
+- `.lock`, this file tells RetroDECK that the settings are done and to not reset them, if this file is missing it will trigger a first boot showing the setup. Here is written the software version that is compared to the actual version to check if an update is needed.
+- `.logs`, logs folder
+- `roms`, if internal is chosen the roms folder is here, otherwise it's in `<sdcard>/retrodeck/roms`
+- `saves`, emulators saves file location
+- `screenshots`, emulators screenshots location
+- `states`, emulators save states location
+- `gamelists`, RetroDECK's gamelist location
+- `texture_packs`, emulators texture packs location
+- `mods`, emulators mods location
+- `.themes`, additional themes folder, `~/.var/app/net.retrodeck.retrodeck/config/emulationstation/.emulationstation/themes` is poiting here
+
+## `~/.var/app/net.retrodeck.retrodeck`
+This folder is the only flatpak folder that is editable user side, it's mapped as `/var` in the flatpak itself, from now on we will use the flatpak paths unless differently specified.
+
+### `config/`
+- `config`, contains all the various software configs such as RetroDECK, retroarch folder and standalones emulator configs
+-- `retroarch`, the retroarch folder (see below)
+-- `emulationstation`, emulationstation home folder (see below)
+-- `retrodeck`, to not be confued with `~/retrodeck/`, this folder contains the retrodeck configs, see below.
+-- various standalone emulators config folders such as `yuzu`, `pcsx2`, `melonDS`, `dolphin-emu` and so on.
+
+### `config/retroarch`
+- `system`, retroarch bios (system) folder, this points to `~/retrodeck/bios`
+- `core`, retroarch cores folder, this is populated by `/app/share/libretro/cores` at the first startup (or with `--reset`, `--reset-ra`)
+- `retroarch.cfg`, the retroarch config, the original one is located in `/app/retrodeck/emu-configs/retroarch.cfg`, and similarly to above it's generated at the first startup
+
+### `config/emulationstation`
+- `ROMs`, this is linked to the roms folder in `~/retroeck/roms`or `<sdcard>/roms`
+- `.emulationstation`, ES-DE main folder
+-- `custom_systems`, where the customs systems are kept (example the tools file), check the official ES-DE docs for more info.
+-- `downloaded_media`, this points to `~/retrodeck/.downloaded_media`
+-- `themes`, this points to `~/retrodeck/.themes`
+-- `es_log.txt`, ES-DE log file
+-- `es_settings.xml`, ES-DE settings file
+
+### `config/retrodeck`
+- `tools`
+- `version`, this file carries the RetroDECK version number and it ś generated during the flatpak build.
+
+### `data/`
+Some emulators, like yuzu, needs this path, here for example is even symlinked the yuzu keys and firmware folder.
+
+## `/var/lib/flatpak/app/net.retrodeck.retrodeck/current/active/files`
+Non-flatpak path: this folders contain file such as the .desktop, icons, etc.
+
+This is mapped as the `/app` folder in flatpak, this folder is inside the read only file system and so all this tree is immutable (actually can be edited by root for develop purposes).<br>
+FYI: you can edit the with KWrite, it justs ask you for the root password when saving.
+
+### /var/lib/flatpak/app/net.retrodeck.retrodeck/current/active/files/share/emulationstation/resources/systems/unix/
+This contains `es_find_rules.xml` and `es_systems.xml`
+
+## `/app/bin`
+All the binary files, like `retrodeck.sh`, the main program (wrapper).
+All these programs can be launched in developer mode just invoking them in the terminal.
+
+### `/app/retrodeck`
+This folder contains the default configuration that is restored with the various `--reset` commands.
+- `emu-configs`
+- `steam`
+- `tools`
+- `es_settings.xml`
+- `tools-gamelist.xml`
+
+
+
+
+
+
+
+
+

wiki-rtd/docs/wiki_general/configurator.md

@@ -0,0 +1,154 @@
+# The RetroDECK Configurator
+
+The `RetroDECK Configurator` is a unique multi-use toolbox that exists within RetroDECK to manage/configure/change/reset/edit many aspect of the application and built around the `RetroDECK Framework`.
+
+The`RetroDECK Configurator` can be found:
+
+* In the main menu inside the ES-DE interface
+
+* From CLI
+
+* From the `.desktop` desktop shortcut.
+
+What follows are the commands you can use inside the Configurator (more commands will be added during development).
+
+## 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.
+
+#### RetroAchivements: Login
+Login to RetroAchievements in all supported emulators and cores.
+
+#### RetroAchivements: Logut
+Logut from RetroAchievements in all supported emulators and cores.
+
+#### RetroAchivements: Hardcore Mode
+Enables `Hardcore Mode` from RetroAchievements in all supported emulators and cores.
+
+#### Widescreen: Enable/Disable
+Enables or disable Widescreen in all supported emulators and cores.
+
+#### Swap A/B and X/Y: Enable/Disable
+Swaps `A/B` `X/Y` in all supported emulators and cores.
+
+#### 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.
+
+### RetroArch: Presets & Settings
+In this menu you will find presets and settings for RetroArch.
+
+#### Borders: Enable/Disable
+
+Enable / Disable borders across the RetroArch cores you choose.
+
+#### Rewind: Enable/Disable
+
+Enable / Disable rewind across all  of RetroArch (this may impact performance on some more demanding systems).
+
+### Wii & Gamecube: Presets & Settings
+In this menu you will find presets and settings for Dolphin and Primehack.
+
+#### Dolphin Textures: Universal Dynamic Input
+Enable / Disable Venomalias's Universal Dynamic Input Texture for Dolphin.
+
+#### Primehack Textures: Universal Dynamic Input
+Enable / Disable Venomalias's Universal Dynamic Input Texture for Primehack.
+
+## 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.
+
+(Please note that several  emulators 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).
+
+The options are the following:
+
+### RetroArch
+Opens RetroArch
+
+### Citra
+Opens Citra
+
+### Dolphin
+Opens Dolphin
+
+### Duckstation
+Opens Duckstation
+
+### MelonDS
+Opens MelonDS
+
+### PCSX2
+Opens PCSX2
+
+### PPSSPP
+Opens PPSSPP
+
+### RPCS3
+Opens RPCS3
+
+### XEMU
+Opens XEMU
+
+### Yuzu
+Opens Yuzu
+
+## 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>
+
+### 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.
+
+### 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.
+
+### Install: PS3 Firmware
+This option downloads and installs the latest PS3 firmware. You will have to press OK to install it.
+
+### RetroDECK: Change update settings
+This option lets you turn on or off automatic updates on launch.
+
+## RetroDECK: Troubleshooting
+
+### Backup: RetroDECK Userdata
+Creates backups of the user data folders
+
+### Check & Verify: Multi-file structure
+Verifies to the structure of multi disc/file games that uses `.m3u` files.
+
+### Check & Verify: BIOS
+Shows a detailed BIOS list of missing and current BIOS.
+
+### RetroDECK: Reset
+The reset menu resets various features
+
+#### Reset Specific Emulator
+Opens up a menu where you can reset a specific emulator
+
+#### Reset All Emulators
+Resets all the emulators at once
+
+#### Reset RetroDECK
+Resets the entirety of RetroDECK.
+
+⚠️ WARNING! BACK UP YOUR DATA BEFORE RUNNING THIS! ⚠️
+
+## RetroDECK: About
+This menu contains information about RetroDECK
+
+### Version history
+Displays the changelogs
+
+### Credits
+Displays the credits

wiki-rtd/mkdocs.yml

@@ -5,10 +5,11 @@ nav:
     - What is RetroDECK?: wiki_general/what-is-retrodeck.md
     - What is included in RetroDECK?: wiki_general/what-is-included.md
     - Supported Systems: wiki_general/supported-systems.md
+    - RetroDECK Configurator: wiki_general/configurator.md
     - The RetroDECK Beta: wiki_general/beta-period.md
     - Known Issues: wiki_general/known-issues.md
 
-  - Community & Helping ❤️:
+  - Community and Helping ❤️:
     - Discord: wiki_community/discord.md
     - Lemmy/Reddit: wiki_community/lemmy-reddit.md
     - How to Contribute to RetroDECK?: wiki_helping/contibute-rd
@@ -21,6 +22,8 @@ nav:
   - Development🔎:
     - Current Version: wiki_rd_versions/version_0.7b/0.7.4b/
     - Version History (Patchnotes): wiki_rd_versions/version-history.md
+    - Folders and Filepaths: wiki_development/folders-filepaths.md
+    - CLI Guide: wiki_development/cli-guide.md
 
   - About RetroDECK 📖:
     - The Team & Credits: wiki_about/team-credits.md