From ec9e159e0f643da356abe144f68fabcf95ad4d9d Mon Sep 17 00:00:00 2001 From: Lazorne Date: Thu, 7 Dec 2023 14:21:35 +0100 Subject: [PATCH] WIKI: Link fixes --- .../linux_desktop/linux-install.md | 24 +- .../wiki_devices/steamdeck/steamdeck-start.md | 2 + .../docs/wiki_howto_faq/retrodeck-move.md | 67 ++- .../docs/wiki_images/logos/linux-tux-logo.svg | 438 ++++++++++++++++++ 4 files changed, 481 insertions(+), 50 deletions(-) create mode 100644 wiki-rtd/docs/wiki_images/logos/linux-tux-logo.svg diff --git a/wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md b/wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md index a536d126..d841af01 100644 --- a/wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md +++ b/wiki-rtd/docs/wiki_devices/linux_desktop/linux-install.md @@ -1,10 +1,12 @@ # How do I install RetroDECK on the Linux Desktop? + + ## Prerequisites 1. You need to have flatpak support installed on your Linux desktop.
Follow the official flatpak guides on how to install it for your distribution:
-https://flatpak.org/setup/ +[Flatpak Setup Guide](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. @@ -22,19 +24,15 @@ https://flatpak.org/setup/ ## 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 +1. Start RetroDECK for the first time +2. Choose where RetroDECK should create the `roms` folders `Internal`, `SDCard` or `Custom`. +3. Put the BIOS inside `~/retrodeck/bios/` for more information read +4. Put the ROMS inside `~/retrodeck/roms/` folder.< -### Other quick tips: -- Read up on the [[EmulationStation DE: User Guide]] -- Check out other recommended software [[Linux Desktop: Software recommendations]] +5. Add RetroDECK to Steam [How-to - Add RetroDECK to Steam](../../wiki_howto_faq/add-to-steam.md) +6. Make sure you have enabled controller support in Steam [How-to - Enable Controllers in Steam ](../wiki_howto_faq/add-to-steam.md) +7. Connect your controller to your Desktop. +8. Launch RetroDECK from Steam and enjoy ## Updates diff --git a/wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md b/wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md index e9fdf912..1cd6ca3b 100644 --- a/wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md +++ b/wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md @@ -1,5 +1,7 @@ # How do I install RetroDECK on the Steam Deck? + + ## Quickstart guide - Put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop` diff --git a/wiki-rtd/docs/wiki_howto_faq/retrodeck-move.md b/wiki-rtd/docs/wiki_howto_faq/retrodeck-move.md index 55919321..b2c1b2a4 100644 --- a/wiki-rtd/docs/wiki_howto_faq/retrodeck-move.md +++ b/wiki-rtd/docs/wiki_howto_faq/retrodeck-move.md @@ -3,7 +3,7 @@ ### Prerequisites: Before you move - Make sure you are running the latest version of RetroDECK on the old device and have started it at least once. - If your device has a battery like a Steam Deck or Laptop, make sure it has enough charge to complete the file transfer. We recommend you are plugged in while doing this to prevent data loss -- **NOTE:** If you old device is broken but you still have access to the data you can skip this step. +- If your old device is broken but you still have access to the data you can skip this step. ## Quickguides @@ -16,12 +16,13 @@ ### Steam Deck 1. Put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop`. 2. Back up existing the RetroDECK `~/retrodeck` folder . -3. On the new Steam Deck install RetroDECK on your [from the Discover store](#step-2-install-from-discover). +3. On the new Steam Deck install RetroDECK on your new Steam Deck. 4. Do not launch RetroDECK on your new device until you have copied over the backed up folders. 5. Copy over the backup folder to the same location (or new) on the new device. 6. Launch RetroDECK on the new device and point towards the `~/retrodeck` location during installation. So if you have moved the `~/retrodeck` to the SD card of the new Steam Deck choose the SD card option during initial install, if you have moved it to the internal storage (home/) choose that option or third chose the custom option. -After that you can keep following following the installation guide [[Steam Deck: Installation and updates]] if you are unsure on progress the installation. +After that you can keep following following the installation guide
+[Steam Deck - Installation and Updates](../wiki_devices/steamdeck/steamdeck-start.md) if you are unsure on progress the installation. ### Linux Desktop 1. Back up existing the RetroDECK `~/retrodeck` folder . @@ -30,7 +31,8 @@ After that you can keep following following the installation guide [[Steam Deck: 4. Copy over the backup folder to the same location (or new) on the new device. 5. Launch RetroDECK on the new device and point towards the `~/retrodeck` location during installation. -After that you can keep following following the installation guide [[Linux Desktop: Installation and updates]] if you are unsure on progress the installation. +After that you can keep following following the installation guide
+[Linux Desktop - Installation and Updates](../wiki_devices/linux_desktop/linux-install.md) if you are unsure on progress the installation. ## Indepth Guide @@ -46,40 +48,23 @@ The location of the folder is where you have chosen to install it like `/home/re This is the location of the core flatpak, emulator files and configurations. -## Two ways to move RetroDECK - -What follows is a short comparison on the two ways to move RetroDECK. - - -### Move just `~/retrodeck` (recommended) - -**Downsides:** -* You will lose all your custom emulator settings inside the emulators (like graphic settings or other tweaks), everything else stays intact. -* You will need to go through the initial setup again and point to the moved retrodeck folder. - -**Upsides:** -* You will get the benefits of a fresh install with all your content intact (saves, games, scraped data etc..). -* You minimize the risks of any file conflicts. - -### Move `~/.var/app/net.retrodeck.retrodeck` and `~/retrodeck` - -**Downsides:** -* Need to reinstall things from configurator like controller profiles. -* Need to make sure you are on the same version before you update. -* If there are any version conflicts within `~/.var/app/net.retrodeck.retrodeck` things could break. - -**Upsides:** -* No first install, just move and play. -* All custom emulator settings you have made are moved. - - ## How to: move from a old Steam Deck to a new Steam Deck? **Note:** Depending on how comfortable you are using the Steam Deck controller to navigate the desktop environment, this may be easier to do with a connected mouse and keyboard. -### Recommended way: Only move `~/retrodeck` +What follows is a short comparison on the two ways to move RetroDECK. + +### Move only `~/retrodeck` (Recommended) + +**Downsides:** + +You will lose all your custom emulator settings inside the emulators (like graphic settings or other tweaks), everything else stays intact and you will need to go through the initial setup again and point to the moved retrodeck folder. + +**Upsides:** + +You will get the benefits of a fresh install with all your content intact (saves, games, scraped data etc..) and you minimize the risks of any file conflicts. #### Step 1: Back up your existing files You will need to backup the the main `~/retrodeck` folder. @@ -92,18 +77,26 @@ You will need to backup the the main `~/retrodeck` folder. #### Step 2: Install RetroDECK on your new Steam Deck -- Follow steps 1 and 2 of the installation guide over at: [[Steam Deck: Installation and updates]] but stop after Step 2 and do not open RetroDECK yet! +- Follow steps 1 and 2 of the installation guide over at: [Steam Deck - Installation and Updates](../wiki_devices/steamdeck/steamdeck-start.md) but stop after Step 2 and do not open RetroDECK yet! #### Step 3: Restore your backed up files - Copy over the `~/retrodeck` to the new device via any of the chosen methods from step 1. - Launch RetroDECK on the new device and point towards the `~/retrodeck` location during installation. So if you have moved the `~/retrodeck` to the SD card of the new Steam Deck choose the SD card option during initial install, if you have moved it to the internal storage choose that option or third chose the custom option. -- Keep following the [[Steam Deck: Installation and updates]] as normal. +- Keep following the [Steam Deck - Installation and Updates](../wiki_devices/steamdeck/steamdeck-start.md) as normal. -### Other way: Move `.var/ files` and `~/retrodeck` +### Move `.var/ files` and `~/retrodeck` (Not Recommended) This is not recommended, but if you know what you are doing you could try this way. +**Downsides:** + +You will need to reinstall things from configurator like controller profiles, must make sure you are on the same version before you update and if there are any version conflicts within `~/.var/app/net.retrodeck.retrodeck` things could break. + +**Upsides:** + +No first install, just move and play and all custom emulator settings you have made are moved. + #### Step 1: Back up your existing files You will need to backup two directories: the main `~/retrodeck` folders and a hidden `~/.var/app/net.retrodeck.retrodeck` folder. @@ -120,9 +113,9 @@ You will need to backup two directories: the main `~/retrodeck` folders and a hi - Navigate to `home/.var/app/net.retrodeck.retrodeck/` and copy the whole folder it to device used for transfer such as a thumb drive, microSD Card, NAS, SFTP and get the files to the new Steam Deck. Or use a transfer software like warpinator to send the folder to the new Steam Deck via network. #### Step 2: Install RetroDECK on your new Steam Deck -- Follow steps 1 and 2 of the installation guide over at: [[Steam Deck: Installation and updates]] but stop after Step 2 and do not open RetroDECK yet! +- Follow steps 1 and 2 of the installation guide over at: [Steam Deck - Installation and Updates](../wiki_devices/steamdeck/steamdeck-start.md) but stop after Step 2 and do not open RetroDECK yet! -### Step 3: Restore your backed up files +#### Step 3: Restore your backed up files - Move the copy of `~/retrodeck` to the same location as the old Steam Deck. - Move the copy of `~/.var/app/net.retrodeck.retrodeck` to `~/.var/app/net.retrodeck.retrodeck` on the new device. - In both cases, you can safely overwrite all existing files. diff --git a/wiki-rtd/docs/wiki_images/logos/linux-tux-logo.svg b/wiki-rtd/docs/wiki_images/logos/linux-tux-logo.svg new file mode 100644 index 00000000..6b558e7b --- /dev/null +++ b/wiki-rtd/docs/wiki_images/logos/linux-tux-logo.svg @@ -0,0 +1,438 @@ + + + Tux + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +