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

100 lines
3.1 KiB
Markdown
Raw Normal View History

2025-02-10 13:30:32 +00:00
# How-to: Start using RetroDECK
2024-01-06 08:25:02 +00:00
2025-02-10 16:59:23 +00:00
<img src="../../wiki_icons/retrodeck/icon-rd.svg" width="100">
2024-01-06 08:25:02 +00:00
2025-02-09 21:38:08 +00:00
## Information
If you don't know what RetroDECK is, read:
[What is RetroDECK?](../wiki_about/what-is-retrodeck.md)
## Step-by-step Getting Started Guide
### Step 0: Prerequisites
2024-01-06 08:25:02 +00:00
2025-02-10 17:19:15 +00:00
<img src="../../wiki_icons/pixelitos/emblem-default.png" width="50">
2025-02-10 16:59:23 +00:00
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
2025-02-09 21:38:08 +00:00
### Step 1: Installation
2025-02-04 08:25:14 +00:00
2025-02-13 08:14:51 +00:00
<img src="../../wiki_icons/pixelitos/steam.png" width="50"> <img src="../../wiki_icons/pixelitos/linux.png" width="50">
2025-02-09 11:43:14 +00:00
2025-02-09 21:38:08 +00:00
#### Steam Deck - Installation
2024-02-24 10:55:45 +00:00
2025-02-09 11:27:12 +00:00
Most of the initial setup needs to be done in `Desktop Mode`.
2025-02-09 08:22:05 +00:00
2025-02-12 08:29:53 +00:00
**Follow the guide:** [Steam Deck - Installation](../wiki_devices/steamdeck/steamdeck-start.md)
2024-01-06 08:25:02 +00:00
2025-02-09 21:38:08 +00:00
#### Linux Desktop - Installation
2024-02-24 10:56:02 +00:00
2025-02-12 08:29:53 +00:00
**Follow the guide:**
[Linux Desktop - Installation](../wiki_devices/linux_desktop/linux-install.md)
2024-01-06 08:25:02 +00:00
2025-02-09 21:38:08 +00:00
### Step 2: Place BIOS & Firmware
2024-02-24 10:55:45 +00:00
2025-02-09 11:43:14 +00:00
<img src="../../wiki_icons/pixelitos/cpu.png" width="50">
2025-02-09 12:03:18 +00:00
Place BIOS & Firmware files in the `retrodeck/bios/` directory.
2024-01-06 08:25:02 +00:00
2025-02-12 08:29:53 +00:00
**Read up on:**
[BIOS/Firmware](../wiki_management/bios-firmware.md)
2025-02-09 21:38:08 +00:00
### Step 3: Place ROMs and Games
2024-01-06 08:25:02 +00:00
2025-02-09 11:43:14 +00:00
<img src="../../wiki_icons/pixelitos/folder-blue-games.png" width="50">
2024-01-06 08:25:02 +00:00
2025-02-09 11:43:14 +00:00
RetroDECK follows ES-DE's folder structure.
Place ROM files in their corresponding system directory inside the `retrodeck/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-09 11:43:14 +00:00
- Place `ExampleNESGame.nes` in the `retrodeck/roms/nes/` folder.
- The result should be: `retrodeck/roms/nes/ExampleNESGame.nes`
2024-01-06 08:25:02 +00:00
2025-02-12 08:29:53 +00:00
**Read up on:**
[RetroDECK Folders](../wiki_management/retrodeck-folders.md)
2025-02-14 08:33:08 +00:00
### Step 4: Read the ES-DE Frontend & RetroDECK Hotkey Guides
2024-02-24 10:55:45 +00:00
2025-02-09 11:43:14 +00:00
<img src="../../wiki_images/logos/es-de-logo.png" width="55">
2025-02-14 08:33:08 +00:00
ES-DE is the main user interface for RetroDECK and RetroDECK uses Steam Input for it's hotkeys.
2025-02-09 12:03:18 +00:00
2025-02-12 08:29:53 +00:00
**Read up on:**
2025-02-14 08:33:08 +00:00
- [ES-DE Frontend: General Guide](../wiki_system_guides/es-de/esde-guide.md)
- [RetroDECK: Controller Hotkeys](../wiki_rd_controls/hotkeys-retrodeck.md)
2024-02-24 10:55:45 +00:00
2025-02-09 21:38:08 +00:00
### Step 5: Playing the Games
2024-01-06 08:25:02 +00:00
2025-02-09 11:43:14 +00:00
<img src="../../wiki_icons/pixelitos/retrodeck.png" width="50">
2025-02-09 11:25:25 +00:00
Launch 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
2025-02-09 11:25:25 +00:00
**Example:**
2024-02-24 10:55:45 +00:00
2025-02-09 11:25:25 +00:00
The NES category should now be shown in the ES-DE Frontend with `ExampleNESGame.nes` from `Step 3`.
2025-02-09 12:03:18 +00:00
2025-02-09 21:43:57 +00:00
### The Optional Step: Explore & Be Part of the Community
2025-02-09 12:03:18 +00:00
2025-02-09 12:08:33 +00:00
<img src="../../wiki_icons/pixelitos/distributor-logo-knoppix.png" width="50">
2025-02-09 21:38:08 +00:00
Feel free to explore the wiki!
2025-02-09 12:03:18 +00:00
2025-02-11 07:23:53 +00:00
- The RetroDECK community is active and widespread. You can find our social links on the [Wiki Start Page](../index.md).
2025-02-09 21:38:08 +00:00
- You can learn how to tweak certain systems from various articles.
2025-02-10 12:12:02 +00:00
- You can read [The RetroDECK Blog](../blog/index.md) to stay updated with development updates.
- You can contribute to the project: [How-to: Contribute to RetroDECK](../wiki_about/contibute-retrodeck.md)
2025-02-09 12:03:18 +00:00