From 63b26f54d4474590bda78bc0b460f6595d562d46 Mon Sep 17 00:00:00 2001 From: Lazorne Date: Sun, 21 Jan 2024 10:26:08 +0100 Subject: [PATCH] Split --- .../docs/wiki_management/about-scraping.md | 21 ++++ .../docs/wiki_management/compability-lists.md | 20 ++++ .../esde-folders-files.md | 3 +- .../docs/wiki_management/games-management.md | 106 ------------------ wiki-rtd/docs/wiki_management/multi-disk.md | 63 +++++++++++ wiki-rtd/mkdocs.yml | 6 +- 6 files changed, 109 insertions(+), 110 deletions(-) create mode 100644 wiki-rtd/docs/wiki_management/about-scraping.md create mode 100644 wiki-rtd/docs/wiki_management/compability-lists.md rename wiki-rtd/docs/{wiki_emulationStation_de => wiki_management}/esde-folders-files.md (99%) delete mode 100644 wiki-rtd/docs/wiki_management/games-management.md create mode 100644 wiki-rtd/docs/wiki_management/multi-disk.md diff --git a/wiki-rtd/docs/wiki_management/about-scraping.md b/wiki-rtd/docs/wiki_management/about-scraping.md new file mode 100644 index 0000000..129142f --- /dev/null +++ b/wiki-rtd/docs/wiki_management/about-scraping.md @@ -0,0 +1,21 @@ +# Scraping + + + +ES-DE supports the two scraper services [ScreenScraper.fr](https://www.screenscraper.fr/) and [TheGamesDB.net](https://thegamesdb.net/). + +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 +- On most occasions you want to use ScreenScraper and not TheGamesDB. But for PC titles scraping from TheGamesDB might be better. +- You will need to register an account on [ScreenScraper.fr](https://www.screenscraper.fr/) to scrape (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. + + diff --git a/wiki-rtd/docs/wiki_management/compability-lists.md b/wiki-rtd/docs/wiki_management/compability-lists.md new file mode 100644 index 0000000..7df2bd1 --- /dev/null +++ b/wiki-rtd/docs/wiki_management/compability-lists.md @@ -0,0 +1,20 @@ +# Compatibility lists + + +Here is a collection of compatibility lists + +## Stand Alone Emulators + +- [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) +- [RetroArch](https://docs.libretro.com/) - There exists no universal compatibility list for RetroArch and it's cores. + + +## Game Engines + +- [ScummVM](https://www.scummvm.org/compatibility) diff --git a/wiki-rtd/docs/wiki_emulationStation_de/esde-folders-files.md b/wiki-rtd/docs/wiki_management/esde-folders-files.md similarity index 99% rename from wiki-rtd/docs/wiki_emulationStation_de/esde-folders-files.md rename to wiki-rtd/docs/wiki_management/esde-folders-files.md index 2428a13..41e412d 100644 --- a/wiki-rtd/docs/wiki_emulationStation_de/esde-folders-files.md +++ b/wiki-rtd/docs/wiki_management/esde-folders-files.md @@ -1,5 +1,4 @@ -# General information - +# Supported file extensions for each emulator **Disclaimer: This list is a work in progress and might contain errors, not all of these systems are enabled** What follows is a list of each systems supported file extensions and the path to the folder where to put the roms. diff --git a/wiki-rtd/docs/wiki_management/games-management.md b/wiki-rtd/docs/wiki_management/games-management.md deleted file mode 100644 index eb65cf1..0000000 --- a/wiki-rtd/docs/wiki_management/games-management.md +++ /dev/null @@ -1,106 +0,0 @@ -# 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 (STILL WIP): -[ES-DE: Folders and Files](../wiki_emulationStation_de/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. - -The folder needs to have the corresponding `.m3u` file and the folder needs to be renamed to the exact filename of the `.m3u`. - -More info in the [ES-DE UserGuide](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#directories-interpreted-as-files). - -**Example:** - -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. - -``` -─── Dragon Fantasy VII.m3u <--- Folder - ├── Dragon Fantasy VII - Disk1.chd <--- Game Disc - ├── Dragon Fantasy VII - Disk2.chd <--- Game Disc - ├── Dragon Fantasy VII - Disk3.chd <--- Game Disc - └── Dragon Fantasy VII.m3u <--- The .m3u file -``` - - -### How do I create a Multidisk Directory? - -Let's use the `Dragon Fantasy VII` example as written above. It is a fake PlayStation 1 game. - -#### Step 1: Make a .m3u sub-folder -Make a new sub-folder inside the `roms/psx` directory (or what ever system you are creating for) 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` - -And it should have the disc files inside of it: - -``` -─── Dragon Fantasy VII.m3u <--- Folder - ├── Dragon Fantasy VII - Disk1.chd <--- Game Disc - ├── Dragon Fantasy VII - Disk2.chd <--- Game Disc - └── Dragon Fantasy VII - Disk3.chd <--- Game Disc -``` - -#### 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 -Dragon Fantasy VII - Disk2.chd -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 compatibility lists - -- [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 - - - -ES-DE supports the two scraper services [ScreenScraper.fr](https://www.screenscraper.fr/) and [TheGamesDB.net](https://thegamesdb.net/). - -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 -- On most occasions you want to use ScreenScraper and not TheGamesDB. But for PC titles scraping from TheGamesDB might be better. -- You will need to register an account on [ScreenScraper.fr](https://www.screenscraper.fr/) to scrape (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. - diff --git a/wiki-rtd/docs/wiki_management/multi-disk.md b/wiki-rtd/docs/wiki_management/multi-disk.md new file mode 100644 index 0000000..26ee737 --- /dev/null +++ b/wiki-rtd/docs/wiki_management/multi-disk.md @@ -0,0 +1,63 @@ +# 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. + +The folder needs to have the corresponding `.m3u` file and the folder needs to be renamed to the exact filename of the `.m3u`. + +More info in the [ES-DE UserGuide](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#directories-interpreted-as-files). + +**Example:** + +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. + +``` +─── Dragon Fantasy VII.m3u <--- Folder + ├── Dragon Fantasy VII - Disk1.chd <--- Game Disc + ├── Dragon Fantasy VII - Disk2.chd <--- Game Disc + ├── Dragon Fantasy VII - Disk3.chd <--- Game Disc + └── Dragon Fantasy VII.m3u <--- The .m3u file +``` + + +## How do I create a Multidisk Directory? + +Let's use the `Dragon Fantasy VII` example as written above. It is a fake PlayStation 1 game. + +### Step 1: Make a .m3u sub-folder +Make a new sub-folder inside the `roms/psx` directory (or what ever system you are creating for) 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` + +And it should have the disc files inside of it: + +``` +─── Dragon Fantasy VII.m3u <--- Folder + ├── Dragon Fantasy VII - Disk1.chd <--- Game Disc + ├── Dragon Fantasy VII - Disk2.chd <--- Game Disc + └── Dragon Fantasy VII - Disk3.chd <--- Game Disc +``` + +### 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 +Dragon Fantasy VII - Disk2.chd +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. diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 30f42bb..6ed9978 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -78,9 +78,12 @@ nav: - Configurator Features: wiki_general/configurator.md - RetroDECK Management 🗜️: - - Manage your Games: wiki_management/games-management.md + - Folders and Files (WIP): wiki_management/esde-folders-files.md + - Game Compability Lists: wiki_management/retrodeck-move.md - Manage your BIOS/Firmware: wiki_management/bios-firmware.md + - Manage your Multidisk/file games: wiki_management/multi-disk.md - Move RetroDECK to a new device: wiki_management/retrodeck-move.md + - Scraping Game Media: wiki_management/about-scraping.md - RetroDECK and Steam 💻: - Add RetroDECK to Steam: wiki_steam/add-to-steam.md @@ -101,7 +104,6 @@ nav: - EmulationStation-DE 📘: - User Guide: wiki_emulationStation_de/esde-guide.md - Themes: wiki_emulationStation_de/esde-themes.md - - Folders and Files (WIP): wiki_emulationStation_de/esde-folders-files.md - Engine Guides 📘: - GZDoom 👹: