Xargon/RetroDECK
1
0
Fork 0
mirror of https://github.com/RetroDECK/RetroDECK.git synced 2025-01-19 15:15:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

stuff

Browse source
This commit is contained in:
Lazorne 2023-11-30 12:58:02 +01:00
parent 9efd944260
commit 1f8fe18d5d
2 changed files with 35 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
wiki-rtd/docs/wiki_devices/steamdeck/steamdeck-start.md
View file

@ -1,16 +1,13 @@
# How do I install RetroDECK on the Steam Deck? # How do I install RetroDECK on the Steam Deck?
### Do you want to move RetroDECK from a old Steam Deck to a new Steam Deck?
Read up here: [How to: Move RetroDECK to a new device](/wiki_faq_guide/move-retrodeck)
## Quickstart guide ## Quickstart guide
- Put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop` - Put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop`
- Install RetroDECK from Discover - Install RetroDECK from Discover
- Start RetroDECK first time in Desktop Mode - Start RetroDECK first time in Desktop Mode
- Choose where RetroDECK should create the `roms` folders `Internal` or `SDCard`. - Choose where RetroDECK should create the `roms` folders `Internal` or `SDCard`.
- Put the BIOS inside `~/retrodeck/bios/` for more information read: [[Emulators: BIOS and Firmware]] - Put the BIOS inside `~/retrodeck/bios/`.
- Put the ROMS inside `~/retrodeck/roms/` or `<sdcard>/retrodeck/roms/` depending on your choice - Put the ROMS inside `~/retrodeck/roms/` or `<sdcard>/retrodeck/roms/` or a custom location.
- In Steam desktop go to the tab `Games` press `Add non Steam game to My library` and select RetroDECK to add it into your library. If that is not working you can `Right Click` on the RetroDECK desktop icon and press `Add to Steam` in the menu. - In Steam desktop go to the tab `Games` press `Add non Steam game to My library` and select RetroDECK to add it into your library. If that is not working you can `Right Click` on the RetroDECK desktop icon and press `Add to Steam` in the menu.
- **Optional way:** Get RetroDECK Steam Grid art and add it to your Steam library with BoilR. Or add the art manually from [SteamgridDB](https://www.steamgriddb.com/search/grids?term=RetroDeck) for the Steam Grid. - **Optional way:** Get RetroDECK Steam Grid art and add it to your Steam library with BoilR. Or add the art manually from [SteamgridDB](https://www.steamgriddb.com/search/grids?term=RetroDeck) for the Steam Grid.
- Switch over to game mode and go to RetroDECK on the Steam Grid under `Library > Non-Steam` - Switch over to game mode and go to RetroDECK on the Steam Grid under `Library > Non-Steam`
@ -18,10 +15,10 @@ Read up here: [How to: Move RetroDECK to a new device](/wiki_faq_guide/move-retr
- Launch RetroDECK and enjoy - Launch RetroDECK and enjoy
### Other quick tips: ### Other quick tips:
- Read up on the [[Controllers: Steam Deck]] to ease your navigation. - Read up on the [[Steam Deck - Controls](wiki_controllers/controls-steamdeck.md) to ease your navigation. :
- Read up on the [[EmulationStation DE: User Guide]] - Read up on the [EmulationStation DE: User Guide](wiki_emulationStation_de/esde-guide.md)
- Check out our other software recommendations [[Steam Deck: Software recommendations]]. - Check out our other software recommendations for the Steam Deck [Steam Deck - Software Recommendations](wiki_devices/steamdeck/steamdeck-software.md).
- Check various optional optimizations that can make some emulators run even better [[Steam Deck: Optimizations]]. - Check various optional optimizations that can make some emulators run even better [Steam Deck - Optimizations](wiki_devices/steamdeck/steamdeck-optimize.md).
## Full step by step guide: ## Full step by step guide:
@ -47,28 +44,27 @@ Read up here: [How to: Move RetroDECK to a new device](/wiki_faq_guide/move-retr
- Go into `Controller Layouts` and press `Templates` - Go into `Controller Layouts` and press `Templates`
- Add the layout for RetroDECK called `RetroDECK: Official Layout` with a version number. - Add the layout for RetroDECK called `RetroDECK: Official Layout` with a version number.
- You can now use RetroDECK and it's ready to populate with ROMS. - You can now use RetroDECK and it's ready to populate with ROMS.
- If you are unsure on how to add ROMS and BIOS to RetroDECK follow the [Getting Started Guide ](https://github.com/XargonWan/RetroDECK/wiki/How-to:-Getting-started) from Step 2 and onward on how to add them. - If you are unsure on how to add ROMS and BIOS to RetroDECK follow the [How-to - Start using RetroDECK](wiki_howto_faq/retrodeck-start.md)
Start using RetroDECK:
### Step 4 (Optional): Extras ### Step 4 (Optional): Extras
- Get RetroDECK Steam Grid art with BoilR or add it manually from [SteamgridDB](https://www.steamgriddb.com/search/grids?term=RetroDeck) for the Steam Grid. - Get RetroDECK Steam Grid art with BoilR or add it manually from [SteamgridDB](https://www.steamgriddb.com/search/grids?term=RetroDeck) for the Steam Grid.
- Check various optional optimizations that can make some emulators run even better [[Steam Deck: Optimizations]]. - Read up on the [[Steam Deck - Controls](wiki_controllers/controls-steamdeck.md) to ease your navigation. :
- Read up on the [[Controllers: Steam Deck]] to ease your navigation. - Read up on the [EmulationStation DE: User Guide](wiki_emulationStation_de/esde-guide.md)
- Read up on the [[EmulationStation DE: User Guide]] - Check out our other software recommendations for the Steam Deck [Steam Deck - Software Recommendations](wiki_devices/steamdeck/steamdeck-software.md).
- Check out our other software recommendations [[Steam Deck: Software recommendations]]. - Check various optional optimizations that can make some emulators run even better [Steam Deck - Optimizations](wiki_devices/steamdeck/steamdeck-optimize.md).
# How do I update RetroDECK on the Steam Deck? ## How do I update RetroDECK on the Steam Deck?
## From Desktop Mode: ### From Desktop Mode:
- Put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop` - Put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop`
- Open the Discover application. - Open the Discover application.
- Click on the updates tab. - Click on the updates tab.
- If there are any updates available it will be shown here. - If there are any updates available it will be shown here.
- Click on the `Update` or `Update all` buttons. - Click on the `Update` or `Update all` buttons.
## Decky: AutoFlatpaks ### Decky: AutoFlatpaks
If you have Decky installed and the AutoFlatpaks plugin. You can update RetroDECK from gamemode. <br> If you have Decky installed and the AutoFlatpaks plugin. You can update RetroDECK from gamemode. <br>
Read more here: [[Steam Deck: Software recommendations]] Read more here: [Steam Deck - Software Recommendations](wiki_devices/steamdeck/steamdeck-software.md).

42
wiki-rtd/docs/wiki_howto_faq/retrodeck-start.md
View file

@ -2,42 +2,38 @@
This is a guide on how to get started with RetroDECK This is a guide on how to get started with RetroDECK
### Do you want to move RetroDECK from another device to a new device? ## Step 0: Prerequisites
Read up here: [[How to: Move RetroDECK to a new device]]
# Step 0: Prerequisites ### 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.
* Have related BIOS & Firmware ready * Have related BIOS & Firmware ready
* 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<br>
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<br>
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<br>
(more information later) (more information later)
# Step 2: BIOS & Firmware ## Step 2: BIOS & Firmware
**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 [BIOS & Firmware](https://github.com/XargonWan/RetroDECK/wiki/BIOS-and-Firmware) Read up on [BIOS & Firmware](https://github.com/XargonWan/RetroDECK/wiki/BIOS-and-Firmware)
* The BIOS & Firmware files go into the `~/retrodeck/bios/` directory <br> * The BIOS & Firmware files go into the `~/retrodeck/bios/` directory <br>
@ -46,31 +42,31 @@ Read up on [BIOS & Firmware](https://github.com/XargonWan/RetroDECK/wiki/BIOS-an
**Example:**<br> **Example:**<br>
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
**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
## 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.<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: 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**<br>
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:<br>
The roms folder is:`~/retrodeck/roms/` The roms folder is:`~/retrodeck/roms/`
### **Choice: SDCard**<br> #### **Choice: SDCard**<br>
If during the installation of RetroDECK you choose the SDCard option for the roms folder:<br> If during the installation of RetroDECK you choose the SDCard option for the roms folder:<br>
The roms folder is: `<sdcard>/retrodeck/roms/`<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> (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>
### **Choice: Custom**<br> #### **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 where ever you choose.
## Let's get started on ROMs: ### Let's get started on ROMs:
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/` 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/`
@ -80,21 +76,21 @@ Read up on [ES-DE Folders and Files](wiki_emulationStation_de/esde-folders-files
You have an example NES game called `ExampleNESGame.nes` <br> You have an example NES game called `ExampleNESGame.nes` <br>
You have to put that game into the `/retrodeck/roms/nes` folder. You have to 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:**<br>
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:**<br>
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:
@ -105,7 +101,7 @@ 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: EmulationStation-DE Themes
You can download more themes for ES-DE's frontend with the built in theme downloader you can find it in: 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` `UI Settings > Theme Downloader`