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

More wiki!

Browse source
This commit is contained in:
Lazorne 2023-11-28 22:18:07 +01:00
parent df23b0c596
commit 0927d64581
1 changed files with 92 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

177
wiki-rtd/docs/wiki_faq_howto/faq.md
View file

@ -1,15 +1,15 @@
# FAQs: Frequently asked questions
# General questions:
## General Questions
## What is the scope of this project?
### What is the scope of this project?
<details><summary>Click here to see the answer</summary>
Read the "Whats the long term vision and goals" on the Home page of this wiki.
</details>
## What is RetroDECK cooker?
### What is RetroDECK cooker?
<details><summary>Click here to see the answer</summary>
Cooker is a bleeding edge snapshot of the current commits, the action of uploading code to GitHub is called commit.<br/>
@ -20,14 +20,14 @@ I don't support the cooker user side.
</details>
### Why the name cooker? 🍲
#### Why the name cooker? 🍲
<details><summary>Click here to see the answer</summary>
That's what cooking in the pot at this moment and not yet ready to be served (released).<br> This name was also used by Linux Mandrake and Mandriva for the bleeding edge channel.
</details>
## What emulators and software is included in RetroDECK?
### What emulators and software is included in RetroDECK?
<details><summary>Click here to see the answer</summary>
RetroDECK comes with:
@ -41,22 +41,22 @@ We plan to have support for all of the the different systems ES-DE support in th
</details>
## Does RetroDECK include any games?
### Does RetroDECK include any games?
<details><summary>Click here to see the answer</summary>
No games are included in RetroDECK currently.
</details>
## Will you include Open Source games in the future as default?
### Will you include Open Source games in the future as default?
<details><summary>Click here to see the answer</summary>
We are looking into a ports downloader for a future update.
</details>
## Does RetroDECK include any Firmware or BIOS?
### Does RetroDECK include any Firmware or BIOS?
<details><summary>Click here to see the answer</summary>
RetroDECK only includes those BIOS and Firmware that are Open Source. All others can never be done for legal reasons.
</details>
### Can you at least point me towards where I find none Open Source: Games, Firmeware or BIOS?
#### Can you at least point me towards where I find none Open Source: Games, Firmeware or BIOS?
<details><summary>Click here to see the answer</summary>
For purchased titles we recommend that you use your own game backups and look into how to extract the Firmware or BIOS from your own consoles.
</details>
@ -64,37 +64,44 @@ For purchased titles we recommend that you use your own game backups and look in
# Flatpak Questions:
## Flatpak
## Retrodeck is a flatpak, what is it?
### Retrodeck is a flatpak, what is it?
<details><summary>Click here to see the answer</summary>
[Flaptak](https://docs.flatpak.org/en/latest/introduction.html) is like sandboxed application, with its own read only filesystem that is different from your computer's filesystem. That's why flatpak is safer than installing something directly in your filesystem as everything it needs is contained within the flatpak.
</details>
### How is a flatpak made?
#### How is a flatpak made?
<details><summary>Click here to see the answer</summary>
A flatpak is generated from a manifest file. A software called flatpak-builder reads the manifest, then starts downloading dependencies and starts building the software. After the build process is done it generates the software in a .flatpak file. This file can then be hosted on flathub or distributed on the web.
</details>
### How does the RetroDECK flatpak manifest look like?
#### How does the RetroDECK flatpak manifest look like?
<details><summary>Click here to see the answer</summary>
You can find out manifest here: https://github.com/XargonWan/RetroDECK/blob/main/net.retrodeck.retrodeck.yml
</details>
# OS Support questions:
## Supported Devices / OS
## Will you support the general Linux desktop and not only the Steam Deck?
### Will you support the general Linux desktop and not only the Steam Deck?
<details><summary>Click here to see the answer</summary>
We do support the Linux Desktop and technically it is working, but the user experience might not be as great as we want it to be. RetroDECK could contain desktop specific bugs and other issues.
You will also need to manually configure the input to match your desktop and might need to tweak more settings. Read more here: [[Linux Desktop: Installation and updates]]
</details>
## Will you support other SteamOS or Linux handheld gaming devices with flatpak support?
#### Will you make a snap version of RetroDECK and just a flatpak version?
<details><summary>Click here to see the answer</summary>
Right now RetroDECK's main focus is flatpak. If the demand is very high for a snap version we might look into it post the launch of version 1.0.
</details>
### Will you support other SteamOS or Linux handheld gaming devices?
<details><summary>Click here to see the answer</summary>
@ -103,51 +110,51 @@ You can get it to run on other Linux based gaming devices it is not just as seam
You will need to manually configure the input to match your device and might need to tweak more settings if you try it on a none Steam Deck device. There might also be some hardware specific bugs.
</details>
## Will you support Windows or Windows based devices like the ROG Ally?
### Will you support Windows or Windows based devices like the ROG Ally?
<details><summary>Click here to see the answer</summary>
No, RetroDECK doesn't support Windows currently and there are no plans to do so.
As an alternative you could try https://www.retrobat.ovh that offers similar functionality in a Windows environment.
How ever if you install a Linux distribution on your device instead you can try out RetroDECK.
</details>
## Will you support MacOS?
### Will you support MacOS?
<details><summary>Click here to see the answer</summary>
Not supported and not planned.
</details>
## Will you support Android/IOS or ARM devices.
### Will you support Android/IOS or ARM devices.
<details><summary>Click here to see the answer</summary>
Not supported, ES-DE does support the ARM emulators but it is a very different landscape. Maybe one day in the far future, but it would need to be a different experience.
Not supported, ES-DE does support the ARM emulators but it is a very different landscape. Maybe one day in the far future, but it would need to be a different experience as the emulators and other systems would not be the same.
</details>
# Feature request questions:
## Feature Requests
## Will you implement X/Y/Z emulator?
### Will you implement X/Y/Z emulator?
<details><summary>Click here to see the answer</summary>
Our goal is to implement and configure a selection of the best emulators for each system. If your favorite system is not integrated you can request its integration by opening an issue on this github page.
</details>
## Will you implement none emulator software inside of RetroDECK like Batocera?
### Will you implement none emulator software inside of RetroDECK like Batocera?
<details><summary>Click here to see the answer</summary>
We do have plans for a ports downloader / manager in the future.
</details>
## I have a good idea on a new feature, how do I suggest it?
### I have a good idea on a new feature, how do I suggest it?
<details><summary>Click here to see the answer</summary>
Check if the request already exists in the issue list on github, if not you can make a new issue and suggest it.
If you want to discuss before submitting feel free to post your ideas in our discord community.
</details>
# Updates and versioning questions:
## RetroDECK Updates
## What does the "b" stand for in the versioning number?
### What does the "b" stand for in the versioning number?
<details><summary>Click here to see the answer</summary>
It stands for Beta.
</details>
## How do I update RetroDECK?
### How do I update RetroDECK?
<details><summary>Click here to see the answer</summary>
Updates to RetroDECK is handled automatically via your software manager when there is a new version released.
@ -156,12 +163,12 @@ Or if you want to update from the terminal you can type: <br>
</details>
## How do I update a specific emulator in RetroDECK?
### How do I update a specific emulator in RetroDECK?
<details><summary>Click here to see the answer</summary>
You can't in a easy way do that without breaking several things. RetroDECK builds many emulators and add RetroDECK specific features on top of them and makes it into one application. That said we are looking into a custom emulator installation for those that have payed early access versions like Yuzu (that installation will still be more limited then the one we ship with RetroDECK and might have less features then normal Yuzu in term of hotkey support and other things).
</details>
## Do you only ship stable versions of the emulators or nightly versions?
### Do you only ship stable versions of the emulators or nightly versions?
<details><summary>Click here to see the answer</summary>
RetroDECK ship the version that is the best for running the games on a case by case basis.
@ -169,34 +176,34 @@ For example: many bleeding edge emulators like Yuzu or RPCS3 it's nightly we shi
Even if it is a nightly version we want to make sure that the version we ship is works.
</details>
## When does the next version of RetroDECK come out?
### When does the next version of RetroDECK come out?
<details><summary>Click here to see the answer</summary>
When it's ready.
</details>
### When does the version after the upcoming version come out?
#### When does the version after the upcoming version come out?
<details><summary>Click here to see the answer</summary>
After the upcoming version.</details>
### When does the version 1.0 of RetroDECK come out?
#### When does the version 1.0 of RetroDECK come out?
<details><summary>Click here to see the answer</summary>
In the future.
</details>
# Documentation questions
## Documentation
## What is sudo?
### What is sudo?
<details><summary>Click here to see the answer</summary>
The command stands for "superuser do" and in the windows world it is called "run as administrator".
Su in "sudo" refers to the "superuser" or in the windows called the "administrator".
</details>
## Whats the meaning of the ~ character mean in documentation and examples?
### Whats the meaning of the ~ character mean in documentation and examples?
<details><summary>Click here to see the answer</summary>
The tilde character ~ is the a short way of saying the logged in users home directory in the UNIX world.<br>
@ -207,26 +214,26 @@ So for example the Steam Deck<br>
Read more on [Wikipedia](https://en.wikipedia.org/wiki/Home_directory)</details>
## Whats the meaning of the SA acronym in documentation and examples?
### Whats the meaning of the SA acronym in documentation and examples?
<details><summary>Click here to see the answer</summary>
SA means Standalone and the emulator is not inside RetroArch/LibRetro but a separate program launched within RetroDECK. </details>
## Whats the meaning of the CLI acronym in documentation and examples?
### Whats the meaning of the CLI acronym in documentation and examples?
<details><summary>Click here to see the answer</summary>
CLI stands for command-line interface and is often refereed commands you can run in the the Linux Terminal </details>
# Other Emulation Solutions questions:
## Other Emulation Solutions
## Are you related to EmuDeck?
### Are you related to EmuDeck?
<details><summary>Click here to see the answer</summary>
No, the two projects are not related.
</details>
### So what's the difference between RetroDECK and EmuDeck?
#### So what's the difference between RetroDECK and EmuDeck?
<details><summary>Click here to see the answer</summary>
Apart of that from the user point of view EmuDeck and RetroDECK may sound similar but technically they're completely different.
@ -243,7 +250,7 @@ This approach of everything is in a all-in-one package will also allow RetroDECK
</details>
### Can I install RetroDECK if I have EmuDeck already?
#### Can I install RetroDECK if I have EmuDeck already?
<details><summary>Click here to see the answer</summary>
Yes, as RetroDECK is completely standalone.
@ -251,21 +258,21 @@ Yes, as RetroDECK is completely standalone.
</details>
### Why create RetroDECK when EmuDeck and other solutions exists?
#### Why create RetroDECK when EmuDeck and other solutions exists?
<details><summary>Click here to see the answer</summary>
RetroDECK is older then EmuDeck, EmuDeck was created later.
</details>
## Are you related anyway to Batocera?
### Are you related anyway to Batocera?
<details><summary>Click here to see the answer</summary>
No, but RetroDECK had some dialog before the project started with some of the Batocera crew if there where any plans to start a Batocera non-OS application (there where no plans at that moment and their focus is to make the best retro gaming operative system). RetroDECK and Batocera also have good dialog together with representatives of each projects inside the internal development channels.
</details>
## Batocera or EmuDeck or RetroDECK I still don't get it?
### Batocera or EmuDeck or RetroDECK I still don't get it?
<details><summary>Click here to see the answer</summary>
- Batocera is a retro emulation operative system that you need to boot into separately (like from an SDCard) or replace your current OS. <br> For the Steam Deck you lose access to the SteamOS features and your emulation gaming is separate from your SteamOS gamemode gaming. That said; Batocera has many years of development time, is a great mature OS with a lot of features.
@ -277,7 +284,7 @@ You can see RetroDECK as the in between of EmuDeck and Batocera. We hope that on
</details>
## What is your relationship with EmulationStation Desktop Edition (ES-DE)?<br>
### What is your relationship with EmulationStation Desktop Edition (ES-DE)?<br>
<details><summary>Click here to see the answer</summary>
ES-DE and RetroDECK are separate projects, but we collaborate to give the best possible user experience.<br>
@ -286,10 +293,10 @@ We have a unique partnership where inside the ES-DE code is a section just for R
</details>
# RetroDECK usage questions:
## RetroDECK Usage
## Do I have to partition or format my disk/sdcard to install RetroDECK?
### Do I have to partition or format my disk/sdcard to install RetroDECK?
<details><summary>Click here to see the answer</summary>
@ -297,14 +304,14 @@ No, partitioning or formatting is not needed at all. RetroDECK (differently from
</details>
## Can I move the ROMs folder to another place?
### Can I move the ROMs folder to another place?
<details><summary>Click here to see the answer</summary>
Yes, you can do so inside the configurator and the `Move RetroDECK` option.
</details>
## Is there a way to reset RetroDECK?
### Is there a way to reset RetroDECK?
<details><summary>Click here to see the answer</summary>
Yes, you can reset various parts of the software using the RetroDECK configurator under the option reset<br/>
@ -326,7 +333,7 @@ flatpak run net.retrodeck.retrodeck --reset-sa
</details>
## How do I uninstall RetroDECK?
### How do I uninstall RetroDECK?
<details><summary>Click here to see the answer</summary>
**On the Steam Deck:**<br>
@ -341,26 +348,26 @@ Put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Deskt
</details>
## Does uninstalling RetroDECK remove my roms, bios and saves?
### Does uninstalling RetroDECK remove my roms, bios and saves?
<details><summary>Click here to see the answer</summary>
No, as long as you don't manually don't delete the ~\RetroDECK folder and it's content your data is safe. You could uninstall RetroDECK and install it again and keep going.
</details>
## How can I move RetroDECK do a different device like Steam Deck OLED or a new Linux PC?
### How can I move RetroDECK do a different device like Steam Deck OLED or a new Linux PC?
<details><summary>Click here to see the answer</summary>
Yes, check over at [[How to: Move RetroDECK to a new device]]
</details>
## Where can I find the logfiles?
### Where can I find the logfiles?
<details><summary>Click here to see the answer</summary>
> In `~/retrodeck/logs/retrodeck.log`
</details>
## Can I add a single game to my Steam Library or with Steam Rom Manager?
### Can I add a single game to my Steam Library or with Steam Rom Manager?
<details><summary>Click here to see the answer</summary>
Not yet but might be in the future, it is technical possible but quite complicated and needs to be done via launch script. We hope we can simplify this in the future via an API call or inside the Configurator.
@ -371,7 +378,7 @@ Example of a launch script to launch to launch a Wii game called Baloon World:
</details>
## If I installed RetroDECK from outside of discover, do I need to uninstall the application to update?
### If I installed RetroDECK from outside of discover, do I need to uninstall the application to update?
<details><summary>Click here to see the answer</summary>
If you previously installed from outside of Discover, you can find the instructions here to
@ -381,7 +388,7 @@ or here
[to install .flatpak file](https://github.com/XargonWan/RetroDECK/wiki/Developer-notes#managing-retrodeck-flatpak-file).</details>
## After installing RetroDECK manually, Discover is not opening or giving me some errors?
### After installing RetroDECK manually, Discover is not opening or giving me some errors?
<details><summary>Click here to see the answer</summary>
This bug is appearing only when installing RetroDECK manually and not from Discover. The discover release is suggested for all the users.
@ -390,9 +397,9 @@ However you can run this to fix it: `flatpak remote-delete retrodeck-origin`
</details>
# General emulation & games questions:
## Emulation & Games
## Why are games call ROMs?
### Why are games call ROMs?
<details><summary>Click here to see the answer</summary>
ROM stands for "Read Only Memory" and was a common method to store games.<br>
@ -402,7 +409,7 @@ Read more on [wikipedia](https://en.wikipedia.org/wiki/Read-only_memory)
</details>
## How can I set another default emulator?
### How can I set another default emulator?
<details><summary>Click here to see the answer</summary>
@ -410,7 +417,7 @@ The ES-DE interface allows you to change emulators for systems that has many dif
</details>
## Game X/Y/Z is not working or showing black screen
### Game X/Y/Z is not working or showing black screen
<details><summary>Click here to see the answer</summary>
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/>
@ -421,7 +428,7 @@ If it still not working you are welcome to ask for support on our [Discord Serve
</details>
## PS2 games are not working or buggy in the RetroArch Core.
### PS2 games are not working or buggy in the RetroArch Core.
<details><summary>Click here to see the answer</summary>
It's a known issue with if you are using the libretro core but you can use the the standalone pcsx2 emulator to solve this issue.<br>
@ -429,7 +436,7 @@ Be sure to check that the bios files are in the correct folder. Read more on the
</details>
## I configured RetroArch but the configuration was not saved.
### I configured RetroArch but the configuration was not saved.
<details><summary>Click here to see the answer</summary>
Configuring RetroArch can be dangerous for an inexperienced user, so RetroDECK is set to don't save the RetroArch configuration upon exiting.<br/>
@ -438,66 +445,66 @@ If you find some better configurations however, you may contribute by sharing it
</details>
## Will you support Lightguns (Sinden, Gun4IR, Samco etc...)?
### Will you support Lightguns (Sinden, Gun4IR, Samco etc...)?
<details><summary>Click here to see the answer</summary>
The long term answer is yes, but there are several issues that need to be addressed from various dependencies that are beyond the scope of what RetroDECK can do by it self. We are talking to several projects and hope to have those issues addressed in the future. Right now the best way to use lightgun hardware is to use Batocera as they have developed native support in their OS.
</details>
# Steam Deck emulation questions:
## Steam Deck Emulation
## Can I launch RetroDECK from inside of the Steam Decks gamemode?
### Can I launch RetroDECK from inside of the Steam Decks gamemode?
<details><summary>Click here to see the answer</summary>
Yes, RetroDECK currently only supports Steam Deck's gamemode as it relies on Steam Controller configs. <br>
To add it into Steam please check the second step of [[Steam Deck: Installation and updates]].
</details>
## XBOX games are slow on the Steam Deck
### XBOX games are slow on the Steam Deck
<details><summary>Click here to see the answer</summary>
Unfortunately on thanks to missing optimizations focusing on the Steam Deck and the hardware is limited in scope makes performance not great. Like most emulators they will get improvements over time and we will follow the XBOX emulators progress with great interest.
</details>
## The games are stuck at 30FPS on the Steam Deck!
### The games are stuck at 30FPS on the Steam Deck!
<details><summary>Click here to see the answer</summary>
Press the [...] button on the Steam Deck, go into the Power menu and see if the Framerate Limit is set to 30FPS and set it to 60FPS or off.
</details>
## Fast forwarding is slow on the Steam Deck!
### Fast forwarding is slow on the Steam Deck!
<details><summary>Click here to see the answer</summary>
Same as above: Check the Power menu Framerate Limit.
</details>
## Some emulators run slow when I got my Steam Deck docked to a 4k, 8k or above resolution monitor.
### Some emulators run slow when I got my Steam Deck docked to a 4k, 8k or above resolution monitor.
<details><summary>Click here to see the answer</summary>
The Steam Deck does not have the power to play all the games in those high resolutions with a stable framerate. What you could do is go into desktop mode while docked and lower the resolution of the display to 1080p or 720p then return to gamemode.
</details>
# Theme questions:
## Emulationstation-DE: Themes
## How can I add more themes?
### How can I add more themes?
<details><summary>Click here to see the answer</summary>
ES-DE comes with a built in Theme Downloader. But you can also add themes manually in the: ~/retrodeck/themes folder.
</details>
## How do you switch between themes inside of RetroDECK?
### How do you switch between themes inside of RetroDECK?
<details><summary>Click here to see the answer</summary>
You can switch between them by open the menu and then navigate to `UI Settings > Theme Set` to select the theme you want to use.
</details>
## "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)?
<details><summary>Click here to see the answer</summary>
* Please make sure you are specifically using a theme that is compatible with [ES-DE](https://www.es-de.org). <br>
@ -511,7 +518,7 @@ You can switch between them by open the menu and then navigate to `UI Settings >
</details>
## Why does the theme layout look squished?
### Why does the theme layout look squished?
<details><summary>Click here to see the answer</summary>
* The Steam Deck has a screen aspect ratio of `16:10` and most themes that you will find are built for an aspect ratio of `16:9`. Depending on the theme's design this may cause the layout to appear squished when using it on the Steam Deck's display. <br>
@ -522,62 +529,62 @@ You can switch between them by open the menu and then navigate to `UI Settings >
</details>
# Scraping questions
## Emulationstation-DE: Scraping
## Can I manually add custom game images/videos/media for games that I can not scrape?
### Can I manually add custom game images/videos/media for games that I can not scrape?
<details><summary>Click here to see the answer</summary>
Yes, check the file structure over at Emulationstation DE's user guide on gitlab.<br>
## [Manually copying game media files](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#manually-copying-game-media-files)
### [Manually copying game media files](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#manually-copying-game-media-files)
</details>
## Where is my scraped data?
### Where is my scraped data?
<details><summary>Click here to see the answer</summary>
In: ~/retrodeck/downloaded_media folder.
</details>
## I got some weird error message about quota after scraping!
### I got some weird error message about quota after scraping!
<details><summary>Click here to see the answer</summary>
The error message mentions something about quota. You have a quota limit on how much you can scrape each day from [Screenscraper.fr ](https://www.screenscraper.fr/) where each item you scrape counts as 1 quota of the daily total.<br>
You can pay them to get a bit more daily quota and show your support or just wait 24 hours.<br>
</details>
## I got some weird error message about about server or service!
### I got some weird error message about about server or service!
<details><summary>Click here to see the answer</summary>
The website is down, check [Screenscraper.fr](https://www.screenscraper.fr/) when they get back up.
</details>
## The scraping is too slow!
### The scraping is too slow!
<details><summary>Click here to see the answer</summary>
[Screenscraper.fr](https://www.screenscraper.fr/) offers different types of donations that can increase your speed with extra threads.
</details>
## My systems storage ran out after scraping!
### My systems storage ran out after scraping!
<details><summary>Click here to see the answer</summary>
Images and videos takes a lot of space, you can clean some out under `~/retrodeck/downloaded_media`
</details>
### But I still want them!
#### But I still want them!
<details><summary>Click here to see the answer</summary>
The only way to still keep them is either: delete something else from the storage or buy more storage.
</details>
## Can I only scrape one game or can I narrow down the scraping method?
### Can I only scrape one game or can I narrow down the scraping method?
<details><summary>Click here to see the answer</summary>
Yes, check the [[EmulationStation DE: User Guide]] for more details.
</details>
## Can I move the downloaded_media folder?
### Can I move the downloaded_media folder?
<details><summary>Click here to see the answer</summary>
You can move it with the the move RetroDECK option inside the configurator.