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

74 lines
2.4 KiB
Markdown
Raw Normal View History

2025-02-04 07:32:30 +00:00
# Getting started with RetroDECK
2024-01-06 08:25:02 +00:00
<img src="../../wiki_icons/pixelitos/retrodeck.png" width="50">
## Step 0: Prerequisites
2025-02-04 07:32:30 +00:00
Before you start, make sure you have:
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
- A device to install RetroDECK on.
- Related BIOS & Firmware ready.
- Game backups of various formats or purchased titles ready to play.
2024-01-06 08:25:02 +00:00
## Step 1: Installation & Configuration
2025-02-04 08:25:14 +00:00
**Steam Deck - Installation**
2024-02-24 10:55:45 +00:00
2025-02-09 08:22:05 +00:00
Most of the initial setup needs to be done in Desktop Mode.
2025-02-04 07:32:30 +00:00
Follow the guide: [Steam Deck - Installation and Updates](../wiki_devices/steamdeck/steamdeck-start.md)
2024-01-06 08:25:02 +00:00
2025-02-04 08:25:14 +00:00
**Linux Desktop - Installation**
2024-02-24 10:56:02 +00:00
2025-02-04 07:32:30 +00:00
Follow the guide: [Linux Desktop - Installation and Updates](../wiki_devices/linux_desktop/linux-install.md)
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
## Step 2: Place BIOS & Firmware
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
2025-02-04 07:32:30 +00:00
Place BIOS & Firmware files in the `~/retrodeck/bios/` directory.
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
## Step 3: Place ROMs and Games
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
RetroDECK follows the ES-DE ROM folder structure.
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
Place ROM files in their corresponding system directory inside the roms folder. The location of the `retrodeck/roms/` folder depends on your installation location choice.
2024-01-06 08:25:02 +00:00
2024-02-24 10:55:45 +00:00
**Example:**
2025-02-04 07:32:30 +00:00
You have an example NES game called: `ExampleNESGame.nes`
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
Place `ExampleNESGame.nes` in the `/retrodeck/roms/nes` folder.
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
## Step 4: Playing the Games
2024-02-24 10:55:45 +00:00
2025-02-04 07:32:30 +00:00
Start RetroDECK via Steam or by itself. The systems you placed ROM files for should be shown and playable.
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
2025-02-04 07:32:30 +00:00
The NES category should now be shown in the ES-DE Frontend with `ExampleNESGame.nes` from `Step 3`.
2024-02-24 10:55:45 +00:00
2024-01-06 08:25:02 +00:00
2025-02-09 08:29:45 +00:00
## Step 5: Making the Games and Interface "Pretty"
2024-01-06 08:25:02 +00:00
2025-02-09 08:29:45 +00:00
You can enhance your experience by adding videos, images, manuals, and art to your games. ES-DE also offers several different themes to choose from.
2024-01-06 08:25:02 +00:00
2025-02-09 08:29:45 +00:00
### Scraping and Screenscraper
1. Read the [ES-DE User Guide](../wiki_system_guides/es-de/esde-guide.md) on scraping.
2. Create an account on [Screenscraper](https://www.screenscraper.fr/).
3. Log in to your Screenscraper account inside RetroDECK `ES-DE Menu` -> `Scraper` -> `Account Settings`.
4. Set up the scraping how you want it under `ES-DE Menu` -> `Scraper` -> `Content Settings`.
2024-01-06 08:25:02 +00:00
5. Start scraping.
2025-02-09 08:29:45 +00:00
6. Enjoy your nicely decorated games.
2024-02-24 10:55:45 +00:00
2025-02-09 08:29:45 +00:00
### ES-DE Themes
2024-01-06 08:25:02 +00:00
2025-02-09 08:29:45 +00:00
You can download more themes for ES-DE's frontend with the built-in theme downloader:
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
`ES-DE Configurations` -> `UI Settings` -> `Theme Downloader`
2024-01-06 08:25:02 +00:00
2025-02-09 08:29:45 +00:00
Switch between themes in:
2024-01-06 08:25:02 +00:00
2025-02-04 07:32:30 +00:00
`ES-DE Configurations` -> `UI Settings` -> `Theme Set`