mirror of
https://github.com/RetroDECK/RetroDECK.git
synced 2024-11-22 05:55:38 +00:00
Fixed wiki paths [skip ci]
This commit is contained in:
parent
a04857c4c7
commit
be69660d25
|
|
@ -19,9 +19,9 @@ If you find a theme you would like to use that is not in the `Theme Downloader`
|
|||
|
||||
## FAQs: Frequently asked questions on Themes
|
||||
|
||||
["Why does the theme I am using not work?" or "Why does the layout look broken?" (black screen with blue text)](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#why-does-the-theme-i-am-using-not-work-or-why-does-the-layout-look-broken-black-screen-with-blue-text)
|
||||
["Why does the theme I am using not work?" or "Why does the layout look broken?" (black screen with blue text)](https://github.com/XargonWan/RetroDECK/wiki/FAQs-Frequently-asked-questions#why-does-the-theme-i-am-using-not-work-or-why-does-the-layout-look-broken-black-screen-with-blue-text)
|
||||
|
||||
[Why does the theme layout look squished?](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#why-does-the-theme-layout-look-squished)
|
||||
[Why does the theme layout look squished?](https://github.com/XargonWan/RetroDECK/wiki/FAQs-Frequently-asked-questions#why-does-the-theme-layout-look-squished)
|
||||
|
||||
# RetroDECK: Included Theme
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ These are mostly technical settings.<br>
|
|||
These are the buttons mappings automatically applied by ES-DE.<br>
|
||||
[General navigation](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#general-navigation)
|
||||
If you are using the Steam Deck look at RetroDECKs hotkeys:
|
||||
[Steam Deck: Hotkeys ](https://github.com/XargonWan/RetroDECK/wiki/Steam-Deck:-Hotkeys)
|
||||
[Steam Deck: Hotkeys ](https://github.com/XargonWan/RetroDECK/wiki/Steam-Deck-Hotkeys)
|
||||
|
||||
### Sound Settings
|
||||
Various sound settings.<br>
|
||||
|
|
@ -9,7 +9,7 @@ For the Steam Deck the `roms` folder location depends on where you choose to ins
|
|||
It's either on the internal storage: `~/retrodeck/roms` or the SDCard: `<sdcard>/retrodeck/roms`<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)
|
||||
[What does ~ mean?](https://github.com/XargonWan/RetroDECK/wiki/FAQs-Frequently-asked-questions#i-see--refereed-in-documentation-and-examples-what-does-it-mean)
|
||||
|
||||
# 3DO
|
||||
- **Roms path:**<br> ~/retrodeck/roms/3do
|
||||
|
|
@ -311,7 +311,7 @@ Example of a launch script to launch to launch a Wii game called Baloon World:
|
|||
<details><summary>Click here to see the answer</summary>
|
||||
If you previously installed from outside of Discover, you can find the instructions here to
|
||||
|
||||
[install from discover](https://github.com/XargonWan/RetroDECK/wiki/Steam-Deck:-Installation-and-updates)
|
||||
[install from discover](https://github.com/XargonWan/RetroDECK/wiki/Steam-Deck-Installation-and-updates)
|
||||
|
||||
or here
|
||||
|
||||
|
|
@ -349,7 +349,7 @@ The ES-DE interface allows you to change emulators for systems that has many dif
|
|||
Some emulators needs BIOS and/or firmware files, first you can check if you got the [needed ones](https://github.com/XargonWan/RetroDECK/wiki/BIOS-&-Firmware).<br/>
|
||||
|
||||
Then you can check if your got a bad dump by comparing your hash with the ones of the official lists on the internet, such as [no-intro](https://datomatic.no-intro.org/index.php?page=search&s=64) or even [RetroAchievements](https://retroachievements.org) if your game is supported.<br/>
|
||||
Moreover please mind that some emulator require very specific roms, please [read here](https://github.com/XargonWan/RetroDECK/wiki/How-to:-Manage-your-games#special-roms-formats).
|
||||
Moreover please mind that some emulator require very specific roms, please [read here](https://github.com/XargonWan/RetroDECK/wiki/How-to-Manage-your-games#special-roms-formats).
|
||||
If it still not working you are welcome to ask for support on our [Discord Server](discord.gg/Dz3szYsP8g).
|
||||
|
||||
</details>
|
||||
|
|
@ -9,9 +9,9 @@ You need to meet the following prerequisites before you start following this gui
|
|||
|
||||
* 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)
|
||||
[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
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ Only install RetroDECK from the official channels via flathub!
|
|||
## Steam Deck - Installation<br>
|
||||
Read and follow the:
|
||||
|
||||
* [Installation guide for the Steam Deck](https://github.com/XargonWan/RetroDECK/wiki/Steam-Deck:-Installation-and-updates)<br>
|
||||
* [Installation guide for the Steam Deck](https://github.com/XargonWan/RetroDECK/wiki/Steam-Deck-Installation-and-updates)<br>
|
||||
|
||||
## Linux Desktop - Installation<br>
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ The roms folder is: `<sdcard>/retrodeck/roms/`<br>
|
|||
|
||||
## 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.
|
||||
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>
|
||||
|
|
@ -86,13 +86,13 @@ The NES column should now be shown with our `ExampleNESGame.nes` from `Step 3`
|
|||
|
||||
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)
|
||||
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)
|
||||
* [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.
|
||||
|
|
@ -101,4 +101,4 @@ RetroDECK comes with several themes built in for the ES-DE interface.
|
|||
* 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)
|
||||
[More information on themes and how to add more](https://github.com/XargonWan/RetroDECK/wiki/EmulationStation-DE-Themes)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
# Supported extensions
|
||||
In order to check which file extensions are supported check the page [Emulators: Folders & File extensions](https://github.com/XargonWan/RetroDECK/wiki/Emulators:-Folders-&-File-extensions)
|
||||
In order to check which file extensions are supported check the page [Emulators: Folders & File extensions](https://github.com/XargonWan/RetroDECK/wiki/Emulators-Folders-&-File-extensions)
|
||||
|
||||
## Special ROMs formats
|
||||
Some emulators are working only with specific rips, here is what I gather.
|
||||
|
|
@ -84,4 +84,4 @@ _Example:_
|
|||
You installed a file that contained the digital game Hockey World 2, it created a directory called `BCA123456` under `retrodeck/bios/rpcs3/dev_hdd0/game/`
|
||||
|
||||
After that you moved `BCA123456` from `retrodeck/bios/rpcs3/dev_hdd0/game/` to `retrodeck/roms/ps3`.
|
||||
The directory `BCA123456` is renamed to `Hockey World 2.ps3`.
|
||||
The directory `BCA123456` is renamed to `Hockey World 2.ps3`.
|
||||
|
|
@ -44,7 +44,7 @@
|
|||
- Go into `Controller Layouts` and press `Templates`
|
||||
- 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.
|
||||
- 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 [Getting Started Guide ](https://github.com/XargonWan/RetroDECK/wiki/How-to-Getting-started) from Step 2 and onward on how to add them.
|
||||
|
||||
|
||||
### Step 4 (Optional): Extras
|
||||
|
|
@ -13,7 +13,7 @@ This increases the VRAM to 4GB in the BIOS, this can give you improvements in ce
|
|||
* Save and Exit
|
||||
|
||||
## Setup a sudo password
|
||||
[What is sudo?](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#what-is-sudo)
|
||||
[What is sudo?](https://github.com/XargonWan/RetroDECK/wiki/FAQs-Frequently-asked-questions#what-is-sudo)
|
||||
|
||||
This is a requirement for many optimizations and solutions, it also makes your Deck safer.
|
||||
It enables you to run commands/applications heighten sudo privileges.
|
||||
|
|
@ -6,7 +6,7 @@ There is a guide on how to install several of them under [Steam Deck: Optimizati
|
|||
|
||||
# Steam Deck specific recommendations
|
||||
|
||||
For general Linux Desktop recommendations go to [Linux Desktop: Software recommendations](https://github.com/XargonWan/RetroDECK/wiki/Linux-Desktop:-Software-recommendations) as many of them also work on the Steam Deck.
|
||||
For general Linux Desktop recommendations go to [Linux Desktop: Software recommendations](https://github.com/XargonWan/RetroDECK/wiki/Linux-Desktop-Software-recommendations) as many of them also work on the Steam Deck.
|
||||
|
||||
## CryoUtilities
|
||||
Scripts and utilities to improve performance and manage storage on the Steam Deck.
|
||||
|
|
@ -375,7 +375,7 @@ These emulators are updated to the latest version available on 31/10/2022.
|
|||
### General information
|
||||
|
||||
|
||||
[I see ~ refereed in documentation and examples, what does it mean?](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#i-see--refereed-in-documentation-and-examples-what-does-it-mean)
|
||||
[I see ~ refereed in documentation and examples, what does it mean?](https://github.com/XargonWan/RetroDECK/wiki/FAQs-Frequently-asked-questions#i-see--refereed-in-documentation-and-examples-what-does-it-mean)
|
||||
|
||||
**Saves = game saves and save states**<br>
|
||||
The word "saves" is used to reference both save files and save state files in this wiki article. Both files are treated in the same manner, the only difference is that saves are located at.
|
||||
|
|
@ -2,64 +2,64 @@
|
|||
[Home[(/XargonWan/RetroDECK/wiki)]
|
||||
|
||||
## RetroDECK: Getting started
|
||||
- [How to: Getting started[(How-to:-Getting-started.md)]
|
||||
- [FAQs: Frequently asked questions[(FAQs:-Frequently-asked-questions.md)]
|
||||
- [EmulationStation DE: User Guide[(EmulationStation-DE:-User-Guide.md)]
|
||||
- [How to: Getting started[(How-to-Getting-started.md)]
|
||||
- [FAQs: Frequently asked questions[(FAQs-Frequently-asked-questions.md)]
|
||||
- [EmulationStation DE: User Guide[(EmulationStation-DE-User-Guide.md)]
|
||||
|
||||
## RetroDECK: General information
|
||||
- [How to: Manage your games[(How-to:-Manage-your-games.md)]
|
||||
- [Emulators: What's included?[(Emulators:-What's-included?.md)]
|
||||
- [Emulators: BIOS and Firmware[(Emulators:-BIOS-and-Firmware.md)]
|
||||
- [Emulators: Different controller layouts[(Emulators:-Diffrent-controller-layouts.md)]
|
||||
- [Emulators: Supported folders and files[(Emulators:-Supported-folders-and-files.md)]
|
||||
- [EmulationStation DE: Themes[é(EmulationStation-DE:-Themes.md)]
|
||||
- [How to: Manage your games[(How-to-Manage-your-games.md)]
|
||||
- [Emulators: What's included?[(Emulators-What's-included.md)]
|
||||
- [Emulators: BIOS and Firmware[(Emulators-BIOS-and-Firmware.md)]
|
||||
- [Emulators: Different controller layouts[(Emulators-Diffrent-controller-layouts.md)]
|
||||
- [Emulators: Supported folders and files[(Emulators-Supported-folders-and-files.md)]
|
||||
- [EmulationStation DE: Themes[é(EmulationStation-DE-Themes.md)]
|
||||
|
||||
## RetroDECK: Configuration
|
||||
- [RetroDECK: Configurator[(RetroDECK:-Configurator.md)]
|
||||
- [RetroDECK: CLI[(RetroDECK:-CLI.md)]
|
||||
- [RetroDECK: Folders and filepaths[(RetroDECK:-Folders-and-filepaths.md)]
|
||||
- [RetroDECK: Configurator[(RetroDECK-Configurator.md)]
|
||||
- [RetroDECK: CLI[(RetroDECK-CLI.md)]
|
||||
- [RetroDECK: Folders and filepaths[(RetroDECK-Folders-and-filepaths.md)]
|
||||
|
||||
## RetroDECK: Development
|
||||
- [Development: General notes[(Development:-General-notes.md)]
|
||||
- [Development: General notes[(Development-General-notes.md)]
|
||||
- [Known Issues[(Known-Issues.md)]
|
||||
- [Version history: Patch Notes[(Version-history:-Patch-Notes.md)]
|
||||
- [How can I help with testing?[(How-can-I-help-with-testing?.md)]
|
||||
- [Version history: Patch Notes[(Version-history-Patch-Notes.md)]
|
||||
- [How can I help with testing?[(How-can-I-help-with-testing.md)]
|
||||
|
||||
|
||||
## Emulator Guides:
|
||||
- [Playstation 3: RPCS3[(Playstation-3:-RPCS3.md)]
|
||||
- [Switch: Yuzu[(Switch:-Yuzu.md)]
|
||||
- [Playstation 3: RPCS3[(Playstation-3-RPCS3.md)]
|
||||
- [Switch: Yuzu[(Switch-Yuzu.md)]
|
||||
|
||||
## Mod Guides:
|
||||
- [Yuzu: Mods[(Yuzu:-Mods.md)]
|
||||
- [Citra: Mods[(Citra:-Mods.md)]
|
||||
- [Dolphin and Primehack: Mods[(Dolphin-and-Primehack:-Mods.md)]
|
||||
- [Yuzu: Mods[(Yuzu-Mods.md)]
|
||||
- [Citra: Mods[(Citra-Mods.md)]
|
||||
- [Dolphin and Primehack: Mods[(Dolphin-and-Primehack-Mods.md)]
|
||||
|
||||
## Texture Packs Guides:
|
||||
|
||||
- [Citra: Texture Packs[(Citra:-Texture-Packs.md)]
|
||||
- [Dolphin and Primehack: Texture Packs[(Dolphin-and-Primehack:-Texture-Packs.md)]
|
||||
- [Duckstation: Texture Packs[(Duckstation:-Texture-Packs.md)]
|
||||
- [RetroArch Mesen: Texture Packs[(RetroArch-Mesen:-Texture-Packs.md)]
|
||||
- [RetroArch Mupen64Plus Next: Texture Packs[(RetroArch-Mupen64Plus-Next:-Texture-Packs.md)]
|
||||
- [PPSSPP: Texture Packs[(PPSSPP:-Texture-Packs.md)]
|
||||
- [PCXS2: Texture Packs[(PCXS2:-Texture-Packs.md)]
|
||||
- [Citra: Texture Packs[(Citra-Texture-Packs.md)]
|
||||
- [Dolphin and Primehack: Texture Packs[(Dolphin-and-Primehack-Texture-Packs.md)]
|
||||
- [Duckstation: Texture Packs[(Duckstation-Texture-Packs.md)]
|
||||
- [RetroArch Mesen: Texture Packs[(RetroArch-Mesen-Texture-Packs.md)]
|
||||
- [RetroArch Mupen64Plus Next: Texture Packs[(RetroArch-Mupen64Plus-Next-Texture-Packs.md)]
|
||||
- [PPSSPP: Texture Packs[(PPSSPP-Texture-Packs.md)]
|
||||
- [PCXS2: Texture Packs[(PCXS2-Texture-Packs.md)]
|
||||
|
||||
## Steam Deck
|
||||
- [Steam Deck: Installation and updates[(Steam-Deck:-Installation-and-updates.md)]
|
||||
- [Steam Deck: Hotkeys and controls[(Steam-Deck:-Hotkeys-and-controls.md)]
|
||||
- [Steam Deck: Optimizations[(Steam-Deck:-Optimizations.md)]
|
||||
- [Steam Deck: Software recommendations[(Steam-Deck:-Software-recommendations.md)]
|
||||
- [Steam Deck: Installation and updates[(Steam-Deck-Installation-and-updates.md)]
|
||||
- [Steam Deck: Hotkeys and controls[(Steam-Deck-Hotkeys-and-controls.md)]
|
||||
- [Steam Deck: Optimizations[(Steam-Deck-Optimizations.md)]
|
||||
- [Steam Deck: Software recommendations[(Steam-Deck-Software-recommendations.md)]
|
||||
|
||||
## Linux Desktop
|
||||
- [Linux Desktop: Software recommendations[(Linux-Desktop:-Software-recommendations.md)]
|
||||
- [Linux Desktop: Software recommendations[(Linux-Desktop-Software-recommendations.md)]
|
||||
|
||||
## Other Devices
|
||||
- (More information later)
|
||||
|
||||
## Credits & Other
|
||||
- [RetroDECK: Credits and The Team[(RetroDECK:-Credits-and-The-Team.md)]
|
||||
- [RetroDECK: The story of RetroDECK[(RetroDECK:-The-story-of-RetroDECK.md)]
|
||||
- [RetroDECK: Social media rules[(RetroDECK:-Social-media-rules.md)]
|
||||
- [RetroDECK: Credits and The Team[(RetroDECK-Credits-and-The-Team.md)]
|
||||
- [RetroDECK: The story of RetroDECK[(RetroDECK-The-story-of-RetroDECK.md)]
|
||||
- [RetroDECK: Social media rules[(RetroDECK-Social-media-rules.md)]
|
||||
- [Licences[(Licences.md)]
|
||||
- [Archive[(Archive.md)]
|
||||
|
|
@ -40,7 +40,7 @@ RetroDECK does not have plans to support Windows, macOS, Android, or iOS.<br>For
|
|||
|
||||
## How do I start using RetroDECK?
|
||||
|
||||
Please read the [How to: Getting started](https://github.com/XargonWan/RetroDECK/wiki/How-to:-Getting-started)
|
||||
Please read the [How to: Getting started](https://github.com/XargonWan/RetroDECK/wiki/How-to-Getting-started)
|
||||
|
||||
## RetroDECK is currently in in BETA and is not a full release.
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ Please read the [How to: Getting started](https://github.com/XargonWan/RetroDECK
|
|||
- RetroDECK is missing some minor and major; emulators, features and configurations. The goal is to have them added over time.<br>
|
||||
Please check the [Known Issues](https://github.com/XargonWan/RetroDECK/wiki/Known-Issues) page and the [Issue tracker](https://github.com/XargonWan/RetroDECK/issues) for more information.
|
||||
|
||||
- RetroDECK during the BETA period only supports the Steam Deck, but for the full release we should have full Linux Desktop support read more at [FAQs: General questions](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#general-questions).
|
||||
- RetroDECK during the BETA period only supports the Steam Deck, but for the full release we should have full Linux Desktop support read more at [FAQs: General questions](https://github.com/XargonWan/RetroDECK/wiki/FAQs-Frequently-asked-questions#general-questions).
|
||||
- The "b" in the versioning stands for BETA but RetroDECK is perfectly fine for daily use even during the beta phase, albeit some features are missing. To see what features are missing check the: [Known Issues page](https://github.com/XargonWan/RetroDECK/wiki/Known-Issues).
|
||||
|
||||
## The RetroDECK community:
|
||||
|
|
|
|||
Loading…
Reference in a new issue