RetroDECK/wiki-rtd/docs/wiki_howto_faq/retrodeck-start.md

113 lines
3.8 KiB
Markdown
Raw Normal View History

2023-11-30 10:47:17 +00:00
# Getting started
This is a guide on how to get started with RetroDECK
2023-11-30 11:58:02 +00:00
## Step 0: Prerequisites
2023-11-30 10:47:17 +00:00
2023-11-30 11:58:02 +00:00
### What do I need?
2023-11-30 10:47:17 +00:00
You need to meet the following prerequisites before you start following this guide:
2023-11-30 11:41:21 +00:00
* You need to have a device to install RetroDECK on.
2023-11-30 10:47:17 +00:00
* Have related BIOS & Firmware ready
2023-11-30 11:41:21 +00:00
* Have game backups of various formats ready that you want to play
2023-11-30 10:47:17 +00:00
2023-11-30 11:58:02 +00:00
## Step 1: Installation & Configuration
2023-11-30 10:47:17 +00:00
Only install RetroDECK from the official channels via flathub!
2023-11-30 11:58:02 +00:00
### Steam Deck - Installation<br>
2023-11-30 10:47:17 +00:00
Read and follow the following guide
2023-11-30 12:08:10 +00:00
[Steam Deck - Installation and Updates](/wiki_devices/steamdeck/steamdeck-start)
2023-11-30 10:47:17 +00:00
2023-11-30 11:58:02 +00:00
### Linux Desktop - Installation<br>
2023-11-30 10:47:17 +00:00
Read and follow the:
2023-11-30 12:08:10 +00:00
[Linux Desktop - Installation and Updates](/wiki_devices/linux_desktop/linux-install)
2023-11-30 10:47:17 +00:00
2023-11-30 11:58:02 +00:00
### Other SteamOS / Linux gaming devices - Installation<br>
2023-11-30 10:47:17 +00:00
(more information later)
2023-11-30 11:58:02 +00:00
## Step 2: BIOS & Firmware
2023-11-30 10:47:17 +00:00
**NOTE:** On the Steam Deck this step needs to be done in Desktop Mode
2023-11-30 11:58:02 +00:00
### Information
2023-11-30 12:08:10 +00:00
Read up on [Manage your BIOS/Firmware](/wiki_howto_faq/bios-firmware)
2023-11-30 10:47:17 +00:00
* The BIOS & Firmware files go into the `~/retrodeck/bios/` directory <br>
**Example:**<br>
You have a BIOS for the PSX called `exampleBIOSPSX.bin`, you just put that file into the `~/retrodeck/bios/` folder.
2023-11-30 11:58:02 +00:00
## Step 3: ROMs
2023-11-30 10:47:17 +00:00
**NOTE:** On the Steam Deck this step needs to be done in Desktop Mode
2023-11-30 11:58:02 +00:00
### On ROMs
2023-11-30 10:47:17 +00:00
Rom files needs to be put in their corresponding system directory inside the `roms` folder.<br>
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:
2023-11-30 11:58:02 +00:00
#### **Choice: Internal**<br>
2023-11-30 10:47:17 +00:00
If during the installation of RetroDECK you choose the Internal option for the roms folder:<br>
The roms folder is:`~/retrodeck/roms/`
2023-11-30 11:58:02 +00:00
#### **Choice: SDCard**<br>
2023-11-30 10:47:17 +00:00
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>
2023-11-30 11:58:02 +00:00
#### **Choice: Custom**<br>
2023-11-30 10:47:17 +00:00
If during the installation of RetroDECK you choose the Custom option for the roms folder:<br>
The roms folder where ever you choose.
2023-11-30 11:58:02 +00:00
### Let's get started on ROMs:
2023-11-30 10:47:17 +00:00
2023-11-30 12:08:10 +00:00
Read up on [ES-DE Folders and Files](/wiki_emulationStation_de/esde-folders-files) to see what folder each system has or read the readme file in each systems folder under `~/retrodeck/roms/`
2023-11-30 11:41:21 +00:00
2023-11-30 10:47:17 +00:00
* Put the corresponding roms inside the corresponding system folder
**Example:**<br>
You have an example NES game called `ExampleNESGame.nes` <br>
You have to put that game into the `/retrodeck/roms/nes` folder.
2023-11-30 11:58:02 +00:00
## Step 4: Playing the Games
2023-11-30 10:47:17 +00:00
2023-11-30 11:58:02 +00:00
### Steam Deck - Gamemode
2023-11-30 10:47:17 +00:00
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>
The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3`
2023-11-30 11:58:02 +00:00
### Linux Desktop
2023-11-30 10:47:17 +00:00
Start up RetroDECK from Steam. Now the systems you put rom files for should be shown and be able to be played.
**Example:**<br>
The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3`
2023-11-30 11:58:02 +00:00
## Step 5: Making the games "pretty" with videos, images and art.
2023-11-30 10:47:17 +00:00
Do the following:
2023-11-30 11:46:06 +00:00
1. Make an account on [Screenscraper](https://www.screenscraper.fr/)
2. Read up on scraping and the various settings that exist for it in the [ES-DE User Guide](wiki_emulationStation_de/esde-guide.md)
3. Login to your screenscraper account inside RetroDECK.
4. Setup the scraping how you want it.
5. Start scraping.
6. Look at your nice pretty games.
2023-11-30 10:47:17 +00:00
2023-11-30 11:58:02 +00:00
## Step 6: EmulationStation-DE Themes
2023-11-30 11:46:06 +00:00
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:
`UI Settings > Theme Set`
2023-11-30 10:47:17 +00:00