Wiki/wiki-rtd/docs/wiki_general/retrodeck-start.md

127 lines
3.7 KiB
Markdown
Raw Normal View History

2024-01-06 08:25:02 +00:00
# Getting started
<img src="../../wiki_icons/pixelitos/retrodeck.png" width="50">
## Step 0: Prerequisites
This is a guide on how to get started with RetroDECK
### What do I need?
2024-02-24 10:55:45 +00:00
2024-01-06 08:25:02 +00:00
You need to meet the following prerequisites before you start following this guide:
* You need to have a device to install RetroDECK on.
* Have related BIOS & Firmware ready
* Have game backups of various formats ready that you want to play
## Step 1: Installation & Configuration
2024-02-24 10:55:45 +00:00
2024-01-06 08:25:02 +00:00
Only install RetroDECK from the official channels via Flathub!
2024-02-24 10:55:45 +00:00
### Steam Deck - Installation
2024-01-06 08:25:02 +00:00
Read and follow the following guide
[Steam Deck - Installation and Updates](../wiki_devices/steamdeck/steamdeck-start.md)
2024-02-24 10:55:45 +00:00
### Linux Desktop - Installation
2024-02-24 10:56:02 +00:00
2024-01-06 08:25:02 +00:00
Read and follow the:
[Linux Desktop - Installation and Updates](../wiki_devices/linux_desktop/linux-install.md)
2024-02-24 10:55:45 +00:00
### Other SteamOS / Linux gaming devices - Installation
2024-01-06 08:25:02 +00:00
(more information later)
## Step 2: BIOS & Firmware
**NOTE:** On the Steam Deck this step needs to be done in Desktop Mode
### Information
2024-02-24 10:55:45 +00:00
2024-01-17 19:44:25 +00:00
Read up on [Manage your BIOS/Firmware](../wiki_management/bios-firmware.md)
2024-01-06 08:25:02 +00:00
2024-02-24 10:55:45 +00:00
* The BIOS & Firmware files go into the `~/retrodeck/bios/` directory
2024-01-06 08:25:02 +00:00
2024-02-24 10:55:45 +00:00
**Example:**
2024-01-06 08:25:02 +00:00
You have a BIOS for the PSX called `exampleBIOSPSX.bin`, you just put that file into the `~/retrodeck/bios/` folder.
## Step 3: ROMs
**NOTE:** On the Steam Deck this step needs to be done in Desktop Mode
### On ROMs
2024-02-24 10:55:45 +00:00
Rom files needs to be put in their corresponding system directory inside the `roms` folder.
2024-01-06 08:25:02 +00:00
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:
2024-02-24 10:55:45 +00:00
#### **Choice: Internal**
If during the installation of RetroDECK you choose the Internal option for the roms folder:
2024-01-06 08:25:02 +00:00
The roms folder is:`~/retrodeck/roms/`
2024-02-24 10:55:45 +00:00
#### **Choice: SDCard**
If during the installation of RetroDECK you choose the SDCard option for the roms folder:
The roms folder is: `<sdcard>/retrodeck/roms/`
2024-01-06 08:25:02 +00:00
2024-02-24 10:55:45 +00:00
(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**
2024-01-06 08:25:02 +00:00
If during the installation of RetroDECK you choose the Custom option for the roms folder:<br>
2024-02-24 10:55:45 +00:00
The roms folder wherever you choose.
2024-01-06 08:25:02 +00:00
2024-02-24 10:55:45 +00:00
### Let us get started on ROMs/Games:
2024-01-06 08:25:02 +00:00
2024-01-21 10:28:36 +00:00
Read up on `RetroDECK Management 🗜️` section of this wiki.
2024-01-06 08:25:02 +00:00
* Put the corresponding roms inside the corresponding system folder
2024-02-24 10:55:45 +00:00
**Example:**
You have an example NES game called `ExampleNESGame.nes`
You must put that game into the `/retrodeck/roms/nes` folder.
2024-01-06 08:25:02 +00:00
## Step 4: Playing the Games
### Steam Deck - Gamemode
2024-02-24 10:55:45 +00:00
2024-01-06 08:25:02 +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.
2024-02-24 10:55:45 +00:00
**Example:**
2024-01-06 08:25:02 +00:00
The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3`
### Linux Desktop
2024-02-24 10:55:45 +00:00
2024-01-06 08:25:02 +00:00
Start up RetroDECK from Steam. Now the systems you put rom files for should be shown and be able to be played.
2024-02-24 10:55:45 +00:00
**Example:**
2024-01-06 08:25:02 +00:00
The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3`
2024-02-24 10:55:45 +00:00
## Step 5: Making the games "pretty" with videos, images, and art.
2024-01-06 08:25:02 +00:00
Do the following:
1. Make an account on [Screenscraper](https://www.screenscraper.fr/)
2024-03-04 11:55:47 +00:00
2. Read up on scraping and the various settings that exist for it in the [ES-DE User Guide](../wiki_es_de/esde-guide.md)
2024-01-06 08:25:02 +00:00
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.
2024-02-24 10:55:45 +00:00
## 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:
2024-01-06 08:25:02 +00:00
2024-02-24 10:55:45 +00:00
`UI Settings - Theme Downloader`
2024-01-06 08:25:02 +00:00
Switch between them and in:
2024-02-24 10:55:45 +00:00
`UI Settings - Theme Set`
2024-01-06 08:25:02 +00:00