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

Bios stuff

Browse source
This commit is contained in:
Lazorne 2023-11-30 11:47:17 +01:00
parent 397db5aa3f
commit 2c0528dc80
7 changed files with 322 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
wiki-rtd/docs/index.md
View file

@ -19,7 +19,8 @@ We are in the process of migrating to MKDocs, but most information is still here
### The RetroDECK community:
[Github](https://github.com/XargonWan/) <br/>
[Website](https://retrodeck.net) <br/>
[Discord](https://discord.gg/Dz3szYsP8g)<br/>
[Lemmy](https://lemmy.zip/c/retrodeck)<br/>
[Subreddit](https://www.reddit.com/r/retrodeck)<br/>
[Reddit](https://www.reddit.com/r/retrodeck)<br/>

8
wiki-rtd/docs/wiki_emulator_guides/gzdoom.md Normal file
View file

@ -0,0 +1,8 @@
# Guide: GZDoom
WIP
## Where to put the games
Doom games should be put under the `retrodeck/roms/doom/` directory.
## .doom folders

114
wiki-rtd/docs/wiki_howto_faq/bios-firmware.md Normal file
View file

@ -0,0 +1,114 @@
# How to: Manage BIOS and Firmware
A BIOS or firmware is like the brain of a computer or electronic device. It helps the device start up and makes sure all its parts work together smoothly. In emulation, having the correct BIOS/firmware is important because it allows the software to pretend to be the real device and work properly.
That's why some emulators require BIOS and Firmware files to work correctly or at all.
Generally the bios files should be put in `~/retrodeck/bios` but there could be exceptions to this.
## RetroArch (Libretro)
Some cores may need some BIOS files to work or run correctly.
[Official Libretro BIOS Guide](https://docs.libretro.com/guides/bios/)
## PPSSPP
[PPSSPP](https://docs.libretro.com/library/ppsspp/)<br/>
Starting everything should be included. <br/>
But if you want the original PSP fonts you can place them in `system/PPSSPP/flash0/font`
## MSX / SVI / ColecoVision / SG-1000
[MSX / SVI / ColecoVision / SG-1000](https://docs.libretro.com/library/bluemsx/#bios)<br/>
Content of [blueMSXv282full.zip](http://bluemsx.msxblue.com/download.html).<br/>
Not the zip itself, its contents must be extracted in `~/retrodeck/bios` folder, more info [here](https://docs.libretro.com/library/bluemsx/#bios).
Starting from v0.5.0b this is automatically provided.
## Yuzu
Yuzu needs the key files `prod.keys`, `title.keys` and the firmware files in the following directories:
**Yuzu keys:** `~/retrodeck/bios/switch/keys`
**Yuzu firmware:** `~/retrodeck/bios/switch/registered`
The directory tree should look like this example:
```
~/retrodeck/bios/switch
├── keys
│   ├── prod.keys
│   └── title.keys
└── registered
├── 02259fd41066eddbc64e0fdd217d9d2f.nca
├── 02582a2cd46cc226ce72c8a52504cd97.nca
├── 02b1dd519a6df4de1b11871851d328a1.nca
├── other 217 files...
└── fd0d23003ea5602c24ac4e41101c16fd.nca
```
You can find a complete guide in the [Yuzu official wiki](https://yuzu-emu.org/help/quickstart/#downloading-and-installing-yuzu) on how to extract the BIOS from your Switch.
## XEMU (Xbox)
These files must be placed with the correct name in the given folders:
```
~/retrodeck/bios/mcpx_1.0.bin'
~/retrodeck/bios/Complex.bin'
~/retrodeck/saves/xbox-eeprom.bin'
[OPTIONAL] ~/retrodeck/bios/xbox_hdd.qcow2'
```
The hard disk is optional as RetroDECK already provides a pre-built 8G Xbox HDD image, free of any copyrighted content, and only containing a dummy dashboard.
So if you want to the complete experience you have to provide your own.
Usually those files are dumped/found as:
```
mcpx_1.0.bin
Complex.bin -> Complex_4627v1.03.bin or Complex_4627.bin
xbox-eeprom.bin -> eeprom.bin
xbox_hdd.qcow2 -> xbox_harddisk-D4920.qcow2
```
So don't forget to rename them for the RetroDECK standards.
## PICO-8
Pico-8 it's not freeware hence it cannot be included with RetroDECK, however it's supported by using these steps:
1. Download PICO-8 for `Linux 64-bit` from the [official website](https://www.lexaloffle.com/games.php?page=updates) or where you bought it.
2. Extract the zipfile somewhere on your desktop
3. Copy the content of the extracted pico-8 folder into `~/retrodeck/bios/pico-8/`
## MelonDS (Standalone), (NDS)
MelonDS by default needs those files:<br/>
- `~/retrodeck/bios/bios9.bin`<br/>
- `~/retrodeck/bios/bios7.bin`<br/>
- `~/retrodeck/bios/firmware.bin`
However there is a setting to disable the need of these files by going to: `Tools` -> `Start MelonDS` -> `Yes` -> `Config` -> `Emu settings` -> `DS-mode` and removing the check on `Use external BIOS/firmware files`.
Please be advised that this operation may prevent the games from running correctly.
## PCSX2 (PS2)
There a multitude of PS2 bios for a complete list with the hashes check <br>
[Gametechwiki](https://emulation.gametechwiki.com/index.php/File_hashes#Known_BIOS_Hashes)
The PS2 bios could be named in the following ways
<br>
By bios version: `ps2-0200a-20040614.bin`
<br>
By system name:`SCPH-70012.bin`
Put the bios inside the bios folder: `~/retrodeck/bios/SCPH-70012.bin`
Here is a list of common used bios with `bios versions/system names/hashes`.
```
ps2-0200a-20040614 - SCPH-70001/SCPH-70011/SCPH-70012 - d333558cc14561c1fdc334c75d5f37b7 -PS2 US BIOS
ps2-0200e-20040614 - SCPH-70002/SCPH-70003/SCPH-70004/SCPH-70008 - dc752f160044f2ed5fc1f4964db2a095 - PS2 EU BIOS
ps2-0200j-20040614 - SCPH-70000 - 0eee5d1c779aa50e94edd168b4ebf42e - PS2 JP BIOS
```
## RPCS3 (PS3)
- Download the [latest PlayStation 3 firmware](https://www.playstation.com/en-us/support/hardware/ps3/system-software/).
- `Tools` -> `RetroDECK Configurator` -> `Change settings` -> `RPCS3` -> `File` -> `Install Firmware`.
For more information on how to load the games check the [official quickstart guide](https://rpcs3.net/quickstart).
## NeoGeo
- `neogeo.zip`
Should go into the `~/retrodeck/roms/neogeo/` folder and the `~/retrodeck/bios` folder. Depending on what emulator you use, the emulator looks for the BIOS in different directories. So the safest way it to just copy the BIOS and put it into both places.

73
wiki-rtd/docs/wiki_howto_faq/games-management.md Normal file
View file

@ -0,0 +1,73 @@
# How to: Manage your Games
# Supported file extensions for each emulator
For a detalied list of which file extensions are supported and where to put the roms check this page:
[ES-DE: Folders and Files](/esde-folders-files/esde-folders-files.md)
# Multidisk/file games: Directory interpreted as files
You can put all the game files inside a sub-folder in order to keep you game list clean, these folder will be seen as the game itself from RetroDECK and not as an actual folder, more info [here](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#directories-interpreted-as-files) on the official ES-DE Documentation. The folder needs to have the corresponding .m3u file and the folder needs to be renamed to the exact filename of the .m3u
Example on how a structure could be:
```
─── Dragon Fantasy VII.m3u
├── Dragon Fantasy VII - Disk1.chd
├── Dragon Fantasy VII - Disk2.chd
├── Dragon Fantasy VII - Disk3.chd
└── Dragon Fantasy VII.m3u
```
In this case the folder will be viewed as a single game and it will launch `Dragon Fantasy VII.m3u` so you can easly swap the disks from RetroArch menu.
## How do I create a Multidisk Directory?
Let's use the Dragon Fantasy VII example as written above.
### Step 1: Make a .m3u sub-folder
Make a new sub-folder inside the PSX roms directory where you move and store the Dragon Fantasy VII files with a .m3u file extension in the end.
The name of the folder will be Dragon Fantasy VII.m3u and the full file path will be:
`~/retrodeck/roms/psx/Dragon Fantasy VII.m3u`
### Step 2: Make a .m3u file inside the folder.m3u
Following the example above, make an empty file inside the Dragon Fantasy VII.m3u folder called the exact same thing as the folder name in this case: `Dragon Fantasy VII.m3u`. Now the full file path to the newly created .m3u file should be like this:
`~/retrodeck/roms/psx/Dragon Fantasy VII.m3u/Dragon Fantasy VII.m3u`
### Step 3: Populate the .m3u file
Open the `Dragon Fantasy VII.m3u` file with an text editor and write the filenames of all files contained in the folder, one per line.
When you are done, the structure of the file should look something like this:
`Dragon Fantasy VII - Disk1.chd`<br>
`Dragon Fantasy VII - Disk2.chd`<br>
`Dragon Fantasy VII - Disk3.chd`
Note this also works with other files types like `.bin` `.iso` `.cue` `.bin` etc.. You just need to make sure that all the files in the folders are written inside the .m3u file.
### Step 4: Launch RetroDECK
The ES-DE interface that RetroDECK uses should now pick up on the game as one file and you can change disks inside RetroArch.
# Emulators compatibility lists
Here is a collection of games that were tested on Steam Deck, not on RetroDECK specifically.
If you find some inconsistences please report them on our `#support` channel on Discord.
* [Citra](https://citra-emu.org/game/)
* [Dolphin](https://dolphin-emu.org/compat/?nocr=true)
* [PCSX2](https://pcsx2.net/compat/)
* [RPCS3](https://docs.google.com/spreadsheets/d/1EzTcNoKiBaMS4orZrGEOKwMpFOZEFKVSOZjLRJqzEkA/)
* [Vita3K](https://vita3k.org/compatibility.html?lang=en)
* [Yuzu](https://yuzu-emu.org/game/)
* [Xemu](https://xemu.app/#compatibility)
# Scraping
Scraping allows you to make the games look "pretty" with coverarts, icons, discimages and more.
Read up on the ES-DE userguide on scraping here:
[ES-DE Scraper guide](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#scraping)
## Quick tips
* Register an account on https://www.screenscraper.fr/ (support them on Patreon for faster downloads, more scrapes per day and priority scraping).
* Login to your Screenscraper.fr account inside of the ES-DE interface in RetroDECK
* Choose what content you want to scrape (remember that each content you choose could take up several mb of data per game).
* Do an initial scrape of all the games you want to scrape.
* If some games are missed do a more narrow scraping by enabling `Scraper -> Other Settings -> Interactive Mode -> On`& Scraper -> `Other Settings -> Auto-Accept Single Game Matches -> On` and choose to scrape by games missing metadata. This will allow you to select each game from a list and also tweak the searches of the missing games. In some cases you need to remove certain aspects of the name like if a rom comes both with a Japanese name and English name, you could try to remove one of the names to find a better result.

0
wiki-rtd/docs/wiki_howto_faq/move-retrodeck.md → wiki-rtd/docs/wiki_howto_faq/retrodeck-move.md
View file

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

@ -0,0 +1,121 @@
# Getting started
This is a guide on how to get started with RetroDECK
### Do you want to move RetroDECK from another device to a new device?
Read up here: [[How to: Move RetroDECK to a new device]]
# Step 0: Prerequisites
## What do I need?
You need to meet the following prerequisites before you start following this guide:
* You need to have a device to install RetroDECK on (we currently only support the Steam Deck).
* Read up on the FAQs pages: <br>
[Do you include any games, firmware or BIOS?](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#do-you-include-any-games-firmware-or-bios)<br>
[Where can I get them?](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#can-you-at-least-point-me-towards-where-i-can-get-them)<br>
[What does ~ mean?](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#i-see--refereed-in-documentation-and-examples-what-does-it-mean)
* Have related BIOS & Firmware ready
* Have backup rom files of the games you want to play ready
# Step 1: Installation & Configuration
Only install RetroDECK from the official channels via flathub!
## Steam Deck - Installation<br>
Read and follow the following guide
[Steam Deck - Installation and Updates](wiki_devices/steamdeck/steamdeck-start.md)
## Linux Desktop - Installation<br>
Read and follow the:
[Linux Desktop - Installation and Updates](wiki_devices/linux_desktop/linux-install.md)
## Other SteamOS / Linux gaming devices - Installation<br>
(more information later)
# Step 2: BIOS & Firmware
**NOTE:** On the Steam Deck this step needs to be done in Desktop Mode
## Information
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>
**Example:**<br>
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
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:
### **Choice: Internal**<br>
If during the installation of RetroDECK you choose the Internal option for the roms folder:<br>
The roms folder is:`~/retrodeck/roms/`
### **Choice: SDCard**<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>
(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>
If during the installation of RetroDECK you choose the Custom option for the roms folder:<br>
The roms folder where ever you choose.
## Let's get started on ROMs:
Read up on [Emulators: Folders & File extensions](https://github.com/XargonWan/RetroDECK/wiki/Emulators:-Folders-&-File-extensions) to see what folder each system has.
* 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.
# Step 4: Playing the ROMs
## 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.
**Example:**<br>
The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3`
## Linux Desktop
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`
# Step 5: Making the games "pretty" with videos, images and art.
Do the following:
1. Make an account on https://www.screenscraper.fr/
2. Read up on scraping on the [ES-DE Guide](https://github.com/XargonWan/RetroDECK/wiki/EmulationStation-DE:-User-Guide#scraping-and-editing-roms-metadata-images-etc)
3. Login to your screenscraper account inside RetroDECK and start scraping.
4. Look at your nice pretty games.
Also read:
* [I got some weird error message about quota after scraping in a foreign language from screenscraper.fr](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#i-got-some-weird-error-message-about-quota-after-scraping-in-a-foreign-language-from-screenscraperfr)
* [My system storage ran out after scraping!](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#my-system-storage-ran-out-after-scraping)
# Step 6: Themes
RetroDECK comes with several themes built in for the ES-DE interface.
## How to switch between themes?
* On the Steam Deck: you can switch between them by pressing the `☰` button to open the menu and then navigate to `UI Settings > Theme Set` to select the theme you want to use.
## How to add more themes?
[More information on themes and how to add more](https://github.com/XargonWan/RetroDECK/wiki/EmulationStation-DE:-Themes)

5
wiki-rtd/mkdocs.yml
View file

@ -13,7 +13,10 @@ nav:
- Known Issues: wiki_general/known-issues.md
- How-to's ❔:
- How-to - Move RetroDECK to a new device: wiki_howto_faq/move-retrodeck.md
- How-to - Start using RetroDECK: wiki_howto_faq/retrodeck-start.md
- How-to - Manage your Games: wiki_howto_faq/games-management.md
- How-to - Manage your BIOS/Firmware: wiki_howto_faq/bios-firmware.md
- How-to - Move RetroDECK to a new device: wiki_howto_faq/retrodeck-move.md
- How-to - Add RetroDECK to Steam: wiki_howto_faq/add-to-steam.md
- How-to - Enable Controllers in Steam: wiki_howto_faq/enable-controllers-steam.md