More edits

wiki-rtd/docs/wiki_about/visions-and-goals.md

@@ -1,4 +1,19 @@
-# Whats the long term vision and goals of the RetroDECK project?
+# Inspiration for RetroDECK and goals
+RetroDECK is inspired by embedded emulation systems like:
+
+- AmberELEC
+- EmuELEC
+- CoreELEC
+- Lakka
+- Batocera
+
+
+The RetroDECK team consists of several veterans from some of the projects mentioned above as well as a bunch of other talented other individuals.
+
+
+# What are the long term vision and goals of the RetroDECK project?
+
+
 The long term vision and goals of the project is an all-in-one application to manage your entire retro games library that is:
 
 - Already configured and should just work with your games.

wiki-rtd/docs/wiki_community/community-rules.md

@@ -0,0 +1,83 @@
+# Discord
+
+## Rules: DO NOT
+
+
+DO NOT: Discuss any type of piracy whatsoever.
+
+DO NOT: Ask for roms, bios, games and where/how to find them and don't PM the RetroDECK team members about it either.
+
+DO NOT: Post NSFW & NSFL content.
+
+DO NOT: Try to sell or promote your products and/or services, this is not a store or a marketplace (discussing experiences, asking for advice and reviews of products related to gaming and retro gaming is fine).
+
+DO NOT: Post hateful comments.
+
+DO NOT: Discuss your political or religious viewpoints here.
+
+DO NOT: Attack server members in the channels or private in PMs on: political viewpoints, religious/non religious believes, gender, race, sexual orientation, age or any other way (if you have been attacked please message a mod in a PM).
+
+DO NOT: Spam or flood the channels.
+
+DO NOT: Share information or pictures about leaked games.
+
+DO NOT: Spoil any new or old game or media. If you want to write about it, use the ||spoiler tag|| to prevent to ruin other user's fruition.
+
+DO NOT: Use the ⁠💬-general channel for support requests. <br>
+Use ⁠🤝-community-support and ask the community help for before creating a official support thread in ⁠🆘-support .
+Before submitting any request please read up on the https://github.com/XargonWan/RetroDECK/wiki.
+
+<details><summary>Rule 42</summary>
+
+DO NOT : Break the space time continuum with time travel and/or para dimensional travelling.
+
+</details>
+
+## Rules: DO
+
+DO: Try to keep memes, light spam and funny posts in the ⁠🐸-random-memes channel (however flooding is always prohibited and all server rules must till be respected even in this channel).
+
+DO: Be patient, be polite, don’t swear and be respectful to each other.
+
+DO: Try your best to keep the topic in the correct channel.
+
+DO: Try your best to help each other.
+
+DO: Be mindful that the RetroDECK team is working on this project out of passion and spending their own free time to make it happen. You can't expect 24/7 hours support and help. When you do feel the need to ask for help or advice from the RetroDECK team respect rule 13.
+
+# Lemmy / Reddit
+
+### 1. DO NOT: Post links/discussion of illegal, copyrighted, pirated or leaked content.
+
+* Post links directly to pirated games, ROMs, BIOSes or shader caches.
+* Partake in discussion or encouragement to in piracy.
+* Ask for technical support for pirated games/software.
+* Post links or discussions to leaked content of any kind.
+* Censoring or obfuscating parts of an link to any part of the content above to bypass filters.
+
+### 2. DO NOT: Post NSFW & NSFL content.
+
+### 3. DO NOT: Make posts about: buying, selling, trading, begging, giveaways, self or crowd-funding without asking.
+
+* You can’t promote crowd-funding, begging, affiliate links or other form of raising funds without asking.
+* Discussing experiences, giving advice or reviews of products related to gaming and retro gaming is always OK!
+* All promotions or marketing must be vetted and approved by the RetroDECK team on Discord.
+
+### 4. DO NOT: Make posts about anything other then RetroDECK, Emulation or community relevant content.
+
+### 5. DO NOT: Post hateful comments or posts.
+
+* Don’t attack any community member on: political viewpoints, religious/non religious believes, gender, race, sexual orientation, age or any other way (if you have been attacked please message the a mod here or on discord).
+* Be patient, be polite, be kind, don’t swear and be respectful to each other.
+
+### 6. DO NOT: Discuss your political or religious viewpoints here.
+
+### 7. DO NOT: Spread misinformation
+
+* Spread intentional misinformation.
+* Impersonate another: entity, company or person.
+
+
+
+# Vivi e lascia vivere
+// RetroDECK Team

wiki-rtd/docs/wiki_faq_howto/howto-move-retrodeck.md

@@ -0,0 +1,133 @@
+# How do I move RetroDECK to a new device?
+
+
+
+### Prerequisites: Before you move
+- Make sure you are running the latest version of RetroDECK on the old device and have started it at least once.
+- If your device has a battery like a Steam Deck or Laptop, make sure it has enough charge to complete the file transfer. We recommend you are plugged in while doing this to prevent data loss.
+
+**NOTE:**
+
+If you old device is broken but you still have access to the data you can skip this step.
+
+
+# Quickguides:
+
+## Ultra Quickguide:
+1. Just copy the `~/retrodeck` folder to the new device to the location you want it.
+2. Install RetroDECK on the new device and point to it the new location of `~/retrodeck` during first setup.
+3. Proceed installation as normal.
+
+## Quickguide - Steam Deck:
+1. Put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop`.
+2. Back up existing the RetroDECK `~/retrodeck` folder .
+3. On the new Steam Deck install RetroDECK on your [from the Discover store](#step-2-install-from-discover).
+4. Do not launch RetroDECK on your new device until you have copied over the backed up folders.
+5. Copy over the backup folder to the same location (or new) on the new device.
+6. Launch RetroDECK on the new device and point towards the `~/retrodeck` location during installation. So if you have moved the `~/retrodeck` to the SD card of the new Steam Deck choose the SD card option during initial install, if you have moved it to the internal storage (home/) choose that option or third chose the custom option.
+
+After that you can keep following following the installation guide [[Steam Deck: Installation and updates]] if you are unsure on progress the installation.
+
+## Quickguide - Linux Desktop:
+1. Back up existing the RetroDECK `~/retrodeck` folder .
+2. On the new PC install RetroDECK from flathub via your application manager.
+3. Do not launch RetroDECK on your new device until you have copied over the backed up folders.
+4. Copy over the backup folder to the same location (or new) on the new device.
+5. Launch RetroDECK on the new device and point towards the `~/retrodeck` location during installation.
+
+After that you can keep following following the installation guide [[Linux Desktop: Installation and updates]] if you are unsure on progress the installation.
+
+# Information on moving RetroDECK:
+
+RetroDECK contains mainly two folders:
+
+`~/retrodeck`<br>
+This is the important folder, that contains all the user content like roms/bios/saves/screenshots/scraped data etc...
+The location of the folder is where you have chosen to install it like `/home/retrodeck` `sd-card` `external drive` `other`.
+
+`~/.var/app/net.retrodeck.retrodeck`<br>
+This is the location of the core flatpak, emulator files and configurations.
+
+
+## Two ways to move RetroDECK:
+
+What follows is a short comparison on the two ways to move RetroDECK.
+
+
+### Move just `~/retrodeck` (recommended)
+
+**Downsides:**
+* You will lose all your custom emulator settings inside the emulators (like graphic settings or other tweaks), everything else stays intact.
+* You will need to go through the initial setup again and point to the moved retrodeck folder.
+
+**Upsides:**
+* You will get the benefits of a fresh install with all your content intact (saves, games, scraped data etc..).
+* You minimize the risks of any file conflicts.
+
+### Move `~/.var/app/net.retrodeck.retrodeck` and `~/retrodeck`
+
+**Downsides:**
+* Need to reinstall things from configurator like controller profiles.
+* Need to make sure you are on the same version before you update.
+* If there are any version conflicts within `~/.var/app/net.retrodeck.retrodeck` things could break.
+
+**Upsides:**
+* No first install, just move and play.
+* All custom emulator settings you have made are moved.
+
+
+# How to: move from a old Steam Deck to a new Steam Deck?
+
+**Note:**
+
+Depending on how comfortable you are using the Steam Deck controller to navigate the desktop environment, this may be easier to do with a connected mouse and keyboard.
+
+## Recommended way: Only move `~/retrodeck`
+
+### Step 1: Back up your existing files
+You will need to backup the the main `~/retrodeck` folder.
+
+- First put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop`.
+- Main `~/retrodeck` folder
+    - Open the Dolphin File Manager (the folder icon in the taskbar).
+    - Navigate to where you installed `~/retrodeck` (this folder should contain sub-folders such as `bios`, `roms`, and `saves`).
+    - Copy the whole folder `~/retrodeck` to a device used for transfer such as a thumb drive, microSD Card, NAS, SFTP and get the files to the new Steam Deck. Or use a transfer software like warpinator to send the folder to the new Steam Deck via network.
+
+
+### Step 2: Install RetroDECK on your new Steam Deck
+- Follow steps 1 and 2 of the installation guide over at: [[Steam Deck: Installation and updates]] but stop after Step 2 and do not open RetroDECK yet!
+
+### Step 3: Restore your backed up files
+- Copy over the `~/retrodeck` to the new device via any of the chosen methods from step 1.
+- Launch RetroDECK on the new device and point towards the `~/retrodeck` location during installation. So if you have moved the `~/retrodeck` to the SD card of the new Steam Deck choose the SD card option during initial install, if you have moved it to the internal storage choose that option or third chose the custom option.
+- Keep following the [[Steam Deck: Installation and updates]] as normal.
+
+
+## Other way: Move `.var/ files` and `~/retrodeck`
+
+This is not recommended, but if you know what you are doing you could try this way.
+
+### Step 1: Back up your existing files
+You will need to backup two directories: the main `~/retrodeck` folders and a hidden `~/.var/app/net.retrodeck.retrodeck` folder.
+
+- First put the Steam Deck into Desktop Mode `Steam button` > `Power` > `Switch to Desktop`.
+- Main `retrodeck` folder
+    - Open the Dolphin File Manager (the folder icon in the taskbar).
+    - Navigate to where you installed `~/retrodeck` (this folder should contain sub-folders such as `bios`, `roms`, and `saves`).
+    - Copy the whole folder `~/retrodeck` to a device used for transfer such as a thumb drive, microSD Card, NAS, SFTP and get the files to the new Steam Deck. Or use a transfer software like warpinator to send the folder to the new Steam Deck via network.
+    - Put the copy in the same location as the old Steam Deck.
+
+- Hidden `net.retrodeck.retrodeck` folder
+    - Return to `home`
+    - Find the "hamburger" menu button (three horizontal lines in the top-right). Open the menu and select `Show Hidden Files`. If on a keyboard, you can type `Ctrl+H`.
+    - Navigate to `home/.var/app/net.retrodeck.retrodeck/` and copy the whole folder it to device used for transfer such as a thumb drive, microSD Card, NAS, SFTP and get the files to the new Steam Deck. Or use a transfer software like warpinator to send the folder to the new Steam Deck via network.
+
+### Step 2: Install RetroDECK on your new Steam Deck
+- Follow steps 1 and 2 of the installation guide over at: [[Steam Deck: Installation and updates]] but stop after Step 2 and do not open RetroDECK yet!
+
+### Step 3: Restore your backed up files
+- Move the copy of `~/retrodeck` to the same location as the old Steam Deck.
+- Move the copy of `~/.var/app/net.retrodeck.retrodeck` to `~/.var/app/net.retrodeck.retrodeck` on the new device.
+- In both cases, you can safely overwrite all existing files.
+- You can now just launch RetroDECK if all have gone well directly from gamemode, without needing to do the initial setup.
+- Don't forget to install the official controller profile in the configurator!

wiki-rtd/docs/wiki_general/known-issues.md

@@ -0,0 +1,44 @@
+# Known issues
+What follows is a list of knows issues.
+For a list of reported bugs please check here on github: [RetroDECK issues](https://github.com/XargonWan/RetroDECK/issues?q=is%3Aissue+is%3Aopen+label%3A%22Bug+%F0%9F%95%B7%EF%B8%8F%22)
+
+## Big issues
+- `RetroArch: ScummVM` Does not work. RetroArch forgot or removed the ScummVM core on the 16.00 release on their build server. This has been reported to LibreRetro by the RetroDECK team on 18-11-23.
+
+## Minor issues
+- `PPSSPP` Retroachievements is in the latest version, you can login / logout / enable hardcore mode normally from the emulators interface. It is right now not configurable in the Configurator (as it works a bit different the other emulators), we hope to have a solution for it at a later date.
+- `RetroArch: Gambatte` Quitting the core with the `Quit` radial function makes the core swap the palette while playing GB.
+- `RetroArch` Borders are in some few cases disappearing in the latest RetroArch version. A possible workaround is to reset RetroArch from the Configurator.
+
+## Hotkey and Controller Issues
+
+**Not all Emulators has hotkey support; some have partial support, some has none and some has a majority implemented**
+
+The plan is to map as much as we can into the RetroDECK Hotkey System below. We are also patching in Emulator Hotkeys with the `RetroDECK Framework` (if possible) to be compatible with the system. If a emulators later versions adds better hotkey support we plan to map it towards the same functions bellow for a unified experience across as many emulators as possible.
+
+### Emulator Issues
+* `PPSSPP` has a bug in with multi-input hotkeys in their flatpak version, so we did a workaround and bound ESC is Open Menu. This allows you to access all of the emulator features and can quit.
+* `RPCS3` hotkeys/shortcuts do not work and they are a new experimental feature. To exit you have to shut down RPCS3 from the `Switch Window` inside the Steam Deck interface.
+* `CEMU` has almost no hotkey support.
+* `XEMU` has no hotkey support.
+*  `Citra` is the only dual-screen emulator that allows a hotkey for changing the screen layout, others: `MelonDS`, `RetroArch`, `Cemu` has no hotkey for it.
+
+# Missing Features
+We are working on implementing all of these features over the big releases. Some will take longer time then others and we will also add more things to this list when needed.
+
+**Missing features:**
+
+* Cloud sync
+* USB transfer
+* STFP
+* Better External controller support.
+* Better gyro support.
+* Dynamic external display resolution support for borders and viewports.
+* All Systems supported by ES-DE so there at least is one emulator per system.
+* A rebuilt Configurator that is a Godot application that support controller navigation.
+* A rebuilt First Run installer in Godot.
+* Better art: Mascot, Easter Eggs, Logos.
+* A profile system and multi-user system.
+
+
+

wiki-rtd/docs/wiki_general/what-is-retrodeck.md

@@ -26,17 +26,3 @@ It can help with:
 - Easier management of `mods` `roms` `texture_packs` `scraped media` `screenshots` `saves / states` `gamelists` and more.
 - Give access to global presets that can be acitivated to configure things over many emulators in one go like: `RetroAchievements`
   `Borders` `Widescreen Mode` `Swaping A/B X/Y for Nintendo Games`
-
-
-
-## Inspiration for RetroDECK and goals
-It's inspired by embedded emulation systems like:
-
-- AmberELEC
-- EmuELEC
-- CoreELEC
-- Lakka
-- Batocera
-
-
-The RetroDECK team consists of several veterans from some of the projects mentioned above as well as a bunch of other talented other individuals.

wiki-rtd/docs/wiki_helping/contibute-rd.md

@@ -0,0 +1,60 @@
+# Can I contribute to the project?
+Yes! Everybody is welcome to contribute in any way possible if it is personal time or funds.
+
+- Do you know how to code and want to contribute? Please join the development team!
+
+- Maybe you know graphics, art or UI & UX design? Join the discussion!
+
+- You can just help by helping others in the support or guide people on various social media and communication platforms.
+
+- You can also help by just finding and testing the best configurations for the emulators and the roms.
+
+- Or just help us by doing bug reports on all the issues you find (please check old issues first before submitting a new one).
+
+- By joining the ✨-new-helpers-start-here channel on [Discord](discord.gg/Dz3szYsP8g) and keeping an eye on the [issues](https://github.com/XargonWan/RetroDECK/issues) tab as well as the [Roadmap](https://github.com/XargonWan/RetroDECK/milestones) tab, you can be up to speed on the latest developments on RetroDECK.
+
+- We have a [Patreon](https://www.patreon.com/RetroDECK) page if you want to help us keep our build servers running or just buy us a beverage.
+
+## Any specific examples of what you need help with?
+
+### Artist/Creators:
+- Create new pixel art for the Radial menus.
+
+- Create easter egg art for various holidays and functions.
+
+- Create menu art for a new Configurator.
+
+- Create input art that can be shown when you start a game.
+
+- Create input art guides for the wiki for the Steam Deck and later various controllers.
+
+- Create patch note and hype videos.
+
+- Create instruction videos.
+
+- Help us make RetroDECK better.
+
+### Developers:
+- Help us put in and make new features.
+
+- Help us make the Configurator a godot application with full controller support.
+
+- Help us get releases out faster.
+
+- Help us make RetroDECK better.
+
+### Testers:
+- Help us test cooker builds and submit bugs and feedback. For how to test them you can check out here: [[How to: Help out with testing cooker builds]]
+
+- Help us make RetroDECK better.
+
+### Everyone:
+
+- Be kind and follow the rules.
+
+- Spread the word of RetroDECK if you like it, if you don't like it or have suggestions put them on github into issues or discuss them on discord.
+
+- Engage with the rest of the community.
+
+- Help us make RetroDECK better.
+

wiki-rtd/docs/wiki_helping/testing-rd.md

@@ -0,0 +1,78 @@
+# Testing RetroDECK
+
+There are two ways help us to test features in RetroDECK.<br>
+The first one is our bleeding edge `RetroDECK Cooker` channel.<br>
+The second one is the `Experimental Features` inside the stable version inside the `Developer Options Menu`.
+
+## Can I help you with testing?
+Yes, do follow the instructions on this page and tell in Discord channel `i-want-to-help` that you are interested in testing out `RetroDECK Cooker`  builds or want to give feedback on `Experimental Features`.
+You will get some instructions from one of the mods and be promoted to a `BetaTester` role.
+
+
+## Before you begin!
+
+### Backup before testing! 🛑
+These builds and features can make you loose all data including `ROMS`, `BIOS` and `Scraped Data` etc..<br>
+We **recommend** that you don't run any experimental features or cooker builds on your main gaming machine.
+
+### Expect bugs and issues! 🛑
+These builds and experimental features can contain several bugs and be unstable.
+
+## How do I take a backup?
+
+Backup your `/retrodeck/` and it's content and `/.var/app/net.retrodeck.retrodeck/`.
+You could copy the entire folders to a secure location or for a quick test you could just rename both of the folders into something else.
+Then RetroDECK will think it's a fresh install.
+
+Example of renaming:<br>
+`OLDnet.retrodeck.retrodeck/`<br>
+`OLDretrodeck/`
+
+
+## What is RetroDECK Cooker?
+[RetroDECK Cooker](https://github.com/XargonWan/RetroDECK-cooker) are the bleeding edge development builds of [RetroDECK](https://github.com/XargonWan/RetroDECK). These builds are only for development and testing purposes.
+
+### How do I install cooker builds?
+You can download the latest `.flatpak` releases from the above link and install them via CLI or from the desktop.
+
+**NOTE:**
+* You need to have set up a sudo password if you want to test on a Steam Deck.
+* If you have `RetroDECK` the stable release on your system `RetroDECK-Cooker` will be installed separately since it is a different branch. We do not recommend running cooker on a system where you have a running `RetroDECK` stable.
+
+#### Desktop
+
+You should just be able to double click on the .`flatpak` file and what ever application manager/installer (like Discover) you have installed should be able to install it. If that does not work use the CLI method.
+
+#### CLI
+
+Run the following command from where you have downloaded the `.flatpak` file. <br>
+`flatpak install RetroDECK.flatpak`
+
+
+## How do I uninstall RetroDECK Cooker?
+
+### Desktop
+Just go into your application manager/installer (like Discover), find RetroDECK and press uninstall.
+
+
+### CLI
+
+Run the following command: <br>
+`flatpak remove RetroDECK`
+
+
+### Why does the cooker release have strange names?
+The names are randomly generated to make it easy to see what build you are running.
+
+## What are RetroDECK experimental features?
+Experimental features are a showcase of what proof-of-concepts we are trying out or working on that you can try out even on stable releases and we would like feedback on them. All these features are just conceptual and we hope them release ready in an later major update or scrap them if the don't work out.
+Standard backup procedures apply as written above.
+
+### How do I enable them?
+
+From CLI run:
+
+`flatpak run net.retrodeck.retrodeck uuddlrlrstart`
+
+The `Developer Options Menu` should show up inside the Configurator.
+

wiki-rtd/mkdocs.yml

@@ -6,6 +6,7 @@ nav:
     - What is included in RetroDECK?: wiki_general/what-is-included.md
     - Supported Systems: wiki_general/supported-systems.md
     - The RetroDECK Beta: wiki_general/beta-period.md
+    - Known Issues: wiki_general/known-issues.md
 
   - About RetroDECK 📖:
     - The Team & Credits: wiki_about/team-credits.md
@@ -16,5 +17,11 @@ nav:
   - FAQ and How-to's ❔:
     - FAQ - Frequently Asked Questions: wiki_faq_howto/faq.md
 
+  - Community 💬:
+    - Community Rules: wiki_community/community-rules.md
+
+  - Helping out 🫶:
+    - How to Contribute to RetroDECK?: wiki_helping/contibute-rd
+    - How to help out with testing?: wiki_helping/testing-rd.md
 
 theme: readthedocs