diff --git a/wiki-rtd/docs/wiki_bugs/report-bugs.md b/wiki-rtd/docs/wiki_bugs/report-bugs.md index 2b700845..f94001cd 100644 --- a/wiki-rtd/docs/wiki_bugs/report-bugs.md +++ b/wiki-rtd/docs/wiki_bugs/report-bugs.md @@ -10,3 +10,6 @@ You can submit bugs and issues on: - On [Github issues](https://github.com/XargonWan/RetroDECK/issues/) - On [Discord](https://discord.gg/Dz3szYsP8g) in the `🤝-community-support` or `🆘-support channels` + - If you are not certain of a issue it is better to discuss it with the community in
+ `🤝-community-support` before submitting it. + diff --git a/wiki-rtd/docs/wiki_howto_faq/.faq.md.kate-swp b/wiki-rtd/docs/wiki_howto_faq/.faq.md.kate-swp new file mode 100644 index 00000000..3e2c46b1 Binary files /dev/null and b/wiki-rtd/docs/wiki_howto_faq/.faq.md.kate-swp differ diff --git a/wiki-rtd/docs/wiki_howto_faq/faq.md b/wiki-rtd/docs/wiki_howto_faq/faq.md index e55d60f2..82878d2a 100644 --- a/wiki-rtd/docs/wiki_howto_faq/faq.md +++ b/wiki-rtd/docs/wiki_howto_faq/faq.md @@ -5,6 +5,9 @@ What follows is questions and answers to a variety of topics. ## General Questions +### What does the "b" stand for in the versioning number? +It stands for Beta. +
### What is RetroDECK cooker? @@ -20,58 +23,30 @@ What follows is questions and answers to a variety of topics.
### What emulators and software is included in RetroDECK? - RetroDECK comes with: - * Emulationstation Desktop Edition - RetroDECK version - * The RetroDECK Framework - * The RetroDECK Configurator - * For emulators and other software check the RetroDECK: What's included? section of this wiki. - - We plan to have support for all of the the different systems ES-DE support in the long term. But the goal is only to have the best emulator per system and not every emulator in existence. +Check `General Information 📰` - `RetroDECK: What's included?`
### Does RetroDECK include any games? - No games are included in RetroDECK currently. +No games are included in RetroDECK.
-### Will you include Open Source games in the future as default? - We are looking into a ports downloader for a future update. +### Will you include Open Source games in the future? +We are looking into a ports downloader for a future update.
### Does RetroDECK include any Firmware or BIOS? - RetroDECK only includes those BIOS and Firmware that are Open Source. All others can never be done for legal reasons. +RetroDECK only includes those BIOS and Firmware that are Open Source. All others can never be done for legal reasons. #### Can you at least point me towards where I find none Open Source: Games, Firmeware or BIOS? - 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. +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.
- -## Flatpak Questions - -
- -### Retrodeck is a flatpak, what is it? - [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. - - -#### How is a flatpak made? - 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. - - -#### How does the RetroDECK flatpak manifest look like? - You can find out manifest here: https://github.com/XargonWan/RetroDECK/blob/main/net.retrodeck.retrodeck.yml - -
- - - -## Using RetroDECK - -
+## RetroDECK Usage Questions ### Do I have to partition or format my disk/sdcard to install RetroDECK? No, partitioning or formatting is not needed at all. RetroDECK (differently from AmberELEC, Batocera and others) comes as a flatpak. Just install it as any other application and launch it from your desktop and/or Steam library. @@ -162,9 +137,9 @@ However you can run this to fix it: `flatpak remote-delete retrodeck-origin`
-## Feature Requests & Bug Reports -
+ +## Feature Requests & Bug Reports ### How to report bugs? @@ -188,14 +163,13 @@ Check `Bugs & Issues 🐜` - `Reporting bugs and issues`
+ + ## Updating RetroDECK
-### What does the "b" stand for in the versioning number? -It stands for Beta. -
### How do I update RetroDECK? Updates to RetroDECK is handled automatically via your software manager when there is a new version released. @@ -313,10 +287,25 @@ We have a unique partnership where inside the ES-DE code is a section just for R
-## Emulation & Games + +## Flatpak Questions + +### Retrodeck is a flatpak, what is it? + [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. + + +#### How is a flatpak made? + 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. + + +#### How does the RetroDECK flatpak manifest look like? + You can find out manifest here: https://github.com/XargonWan/RetroDECK/blob/main/net.retrodeck.retrodeck.yml
+ +## Emulation & Games + ### Why are games call ROMs? ROM stands for "Read Only Memory" and was a common method to store games. The games where later dumped from their ROM chips into digitalized files that can be played with an emulator. @@ -384,9 +373,9 @@ Read more on [wikipedia](https://en.wikipedia.org/wiki/Read-only_memory)
-## Emulationstation-DE: Themes -
+ +## Emulationstation-DE: Themes ### How can I add more themes? ES-DE comes with a built in Theme Downloader `UI Settings Theme Downloader`. But you can also add themes manually in the: `~/retrodeck/themes` folder. @@ -418,9 +407,9 @@ Read more on [wikipedia](https://en.wikipedia.org/wiki/Read-only_memory)
-## Emulationstation-DE: Scraping -
+ +## Emulationstation-DE: Scraping ### Can I manually add custom game images/videos/media for games that I can not scrape? Yes, check the file structure over at Emulationstation DE's user guide on gitlab. diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 1963c485..41ec518c 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -39,15 +39,13 @@ nav: - What is RetroDECK?: wiki_general/what-is-retrodeck.md - What is included in RetroDECK?: wiki_general/what-is-included.md - Supported Devices: wiki_general/supported-devices.md - - RetroDECK Configurator: wiki_general/configurator.md - - The RetroDECK Beta: wiki_general/beta-period.md + - The RetroDECK Beta: wiki_general/beta-period.md' + + - RetroDECK Configurator 🛠️: wiki_general/configurator.md - FAQ ❔: wiki_howto_faq/faq.md -## Things Xargon broke - - Bugs & Issues 🐜: - - Reporting: wiki_bugs/report-bugs.md - - Known Issues: wiki_bugs/known-issues.md + - How-to's 💬: - How-to - Start using RetroDECK: wiki_howto_faq/retrodeck-start.md @@ -96,6 +94,16 @@ nav: - Steam Deck - Controls: wiki_controllers/controls-steamdeck.md - Playstation - Controllers (WIP): wiki_controllers/controllers-playstation.md + - Community & Helping Out ❤️: + - Discord: wiki_community/discord.md + - Lemmy/Reddit: wiki_community/lemmy-reddit.md + - How to Contribute to RetroDECK?: wiki_community/contibute-rd.md + - How to help out with testing?: wiki_community/testing-rd.md + + - Bugs & Issues 🐜: + - Reporting: wiki_bugs/report-bugs.md + - Known Issues: wiki_bugs/known-issues.md + - Development 🖥️: - Current Version: wiki_rd_versions/version_0.7b/0.7.4b.md - Version History (Patchnotes): wiki_rd_versions/version-history.md @@ -103,11 +111,7 @@ nav: - CLI Guide: wiki_development/cli-guide.md - Development Notes: wiki_development/general-development.md - - Community & Helping Out ❤️: - - Discord: wiki_community/discord.md - - Lemmy/Reddit: wiki_community/lemmy-reddit.md - - How to Contribute to RetroDECK?: wiki_community/contibute-rd.md - - How to help out with testing?: wiki_community/testing-rd.md + - About RetroDECK 📖: - The Team & Credits: wiki_about/team-credits.md