This commit is contained in:
Lazorne 2024-02-24 11:55:45 +01:00
parent c41dffec8f
commit f07c53dc96

View file

@ -7,6 +7,7 @@
This is a guide on how to get started with RetroDECK This is a guide on how to get started with RetroDECK
### What do I need? ### What do I need?
You need to meet the following prerequisites before you start following this guide: You need to meet the following prerequisites before you start following this guide:
* You need to have a device to install RetroDECK on. * You need to have a device to install RetroDECK on.
@ -14,20 +15,22 @@ You need to meet the following prerequisites before you start following this gui
* Have game backups of various formats ready that you want to play * Have game backups of various formats ready that you want to play
## Step 1: Installation & Configuration ## Step 1: Installation & Configuration
Only install RetroDECK from the official channels via Flathub! Only install RetroDECK from the official channels via Flathub!
### Steam Deck - Installation<br> ### Steam Deck - Installation
Read and follow the following guide Read and follow the following guide
[Steam Deck - Installation and Updates](../wiki_devices/steamdeck/steamdeck-start.md) [Steam Deck - Installation and Updates](../wiki_devices/steamdeck/steamdeck-start.md)
### Linux Desktop - Installation<br> ### Linux Desktop - Installation
Read and follow the: Read and follow the:
[Linux Desktop - Installation and Updates](../wiki_devices/linux_desktop/linux-install.md) [Linux Desktop - Installation and Updates](../wiki_devices/linux_desktop/linux-install.md)
### Other SteamOS / Linux gaming devices - Installation<br> ### Other SteamOS / Linux gaming devices - Installation
(more information later) (more information later)
@ -36,12 +39,13 @@ Read and follow the:
**NOTE:** On the Steam Deck this step needs to be done in Desktop Mode **NOTE:** On the Steam Deck this step needs to be done in Desktop Mode
### Information ### Information
Read up on [Manage your BIOS/Firmware](../wiki_management/bios-firmware.md) Read up on [Manage your BIOS/Firmware](../wiki_management/bios-firmware.md)
* The BIOS & Firmware files go into the `~/retrodeck/bios/` directory <br> * The BIOS & Firmware files go into the `~/retrodeck/bios/` directory
**Example:**<br> **Example:**
You have a BIOS for the PSX called `exampleBIOSPSX.bin`, you just put that file into the `~/retrodeck/bios/` folder. You have a BIOS for the PSX called `exampleBIOSPSX.bin`, you just put that file into the `~/retrodeck/bios/` folder.
## Step 3: ROMs ## Step 3: ROMs
@ -50,49 +54,55 @@ You have a BIOS for the PSX called `exampleBIOSPSX.bin`, you just put that file
### On ROMs ### On ROMs
Rom files needs to be put in their corresponding system directory inside the `roms` folder.<br> Rom files needs to be put in their corresponding system directory inside the `roms` folder.
Note that the `roms` folder location can be different depending on where you choose to put it during the installation process. The following options are available during the installation: Note that the `roms` folder location can be different depending on where you choose to put it during the installation process. The following options are available during the installation:
#### **Choice: Internal**<br> #### **Choice: Internal**
If during the installation of RetroDECK you choose the Internal option for the roms folder:<br>
If during the installation of RetroDECK you choose the Internal option for the roms folder:
The roms folder is:`~/retrodeck/roms/` The roms folder is:`~/retrodeck/roms/`
#### **Choice: SDCard**<br> #### **Choice: SDCard**
If during the installation of RetroDECK you choose the SDCard option for the roms folder:<br>
The roms folder is: `<sdcard>/retrodeck/roms/`<br>
(Please note that the `<sdcard>` is an example and not called so inside your Linux/SteamOS system but rather your unique per SDCard ID number).<br> If during the installation of RetroDECK you choose the SDCard option for the roms folder:
The roms folder is: `<sdcard>/retrodeck/roms/`
(Please note that the `<sdcard>` is an example and not called so inside your Linux/SteamOS system but rather your unique per SDCard ID number).
#### **Choice: Custom**
#### **Choice: Custom**<br>
If during the installation of RetroDECK you choose the Custom option for the roms folder:<br> If during the installation of RetroDECK you choose the Custom option for the roms folder:<br>
The roms folder where ever you choose. The roms folder wherever you choose.
### Let's get started on ROMs/Games: ### Let us get started on ROMs/Games:
Read up on `RetroDECK Management 🗜️` section of this wiki. Read up on `RetroDECK Management 🗜️` section of this wiki.
* Put the corresponding roms inside the corresponding system folder * Put the corresponding roms inside the corresponding system folder
**Example:**<br> **Example:**
You have an example NES game called `ExampleNESGame.nes` <br>
You have to put that game into the `/retrodeck/roms/nes` folder. You have an example NES game called `ExampleNESGame.nes`
You must put that game into the `/retrodeck/roms/nes` folder.
## Step 4: Playing the Games ## Step 4: Playing the Games
### Steam Deck - Gamemode ### Steam Deck - Gamemode
Return to gamemode on the Steam Deck and start up RetroDECK. Now the systems you put rom files for should be shown and be able to be played. Return to gamemode on the Steam Deck and start up RetroDECK. Now the systems you put rom files for should be shown and be able to be played.
**Example:**<br> **Example:**
The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3` The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3`
### Linux Desktop ### Linux Desktop
Start up RetroDECK from Steam. Now the systems you put rom files for should be shown and be able to be played. Start up RetroDECK from Steam. Now the systems you put rom files for should be shown and be able to be played.
**Example:**<br> **Example:**
The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3` The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3`
## Step 5: Making the games "pretty" with videos, images and art. ## Step 5: Making the games "pretty" with videos, images, and art.
Do the following: Do the following:
@ -103,12 +113,13 @@ Do the following:
5. Start scraping. 5. Start scraping.
6. Look at your nice pretty games. 6. Look at your nice pretty games.
## Step 6: EmulationStation-DE Themes ## Step 6: ES-DE Themes
You can download more themes for ES-DE's frontend with the built in theme downloader you can find it in:
`UI Settings > Theme Downloader` You can download more themes for ES-DE's frontend with the built-in theme downloader you can find it in:
`UI Settings - Theme Downloader`
Switch between them and in: Switch between them and in:
`UI Settings > Theme Set` `UI Settings - Theme Set`