mirror of
https://github.com/RetroDECK/Wiki.git
synced 2025-01-31 10:25:39 +00:00
all of testing
This commit is contained in:
laz
parent
24289a199e
commit
2304ad1fc7
|
|
@ -46,11 +46,3 @@ More information in the `Community & Helping Out ❤️` section
|
|||
### Service Status
|
||||
[Github - Status](https://www.githubstatus.com/)<br>
|
||||
[Flathub - Status](https://status.flathub.org/)<br>
|
||||
|
||||
|
||||
|
||||
|
||||
## Do you want to help to contribute to the wiki?
|
||||
|
||||
Join the [Discord](https://discord.gg/WDc5C9YWMx) and post in `💙-i-want-to-help` channel that you want to help with the wiki.<br>
|
||||
You will then get access to the `🖋-wiki-maintainers`channel by one of the mods and you can discuss with your fellow contributors in that channel.
|
||||
|
|
|
|||
72
wiki-rtd/docs/wiki_development/testing/cooker-testing.md
Normal file
72
wiki-rtd/docs/wiki_development/testing/cooker-testing.md
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
# RetroDECK Cooker Guide: Testing Builds
|
||||
|
||||
If you are on `SteamOS` like on the Steam Deck make sure you are in `Desktop Mode` before you begin.
|
||||
|
||||
🛑 **Do install cooker without following this guide** 🛑
|
||||
|
||||
We do not recommend to blindly install the Cooker without reading **THIS GUIDE** and **FOLLOW THE INSTRUCTIONS** written here.
|
||||
|
||||
To just install RetroDECK Cooker and hope for the best is now known the `Rowan Skye Method`.
|
||||
|
||||
Because of mistakes that where made from a chaotic blue draconic wolfkin tester living on the edge with nothing to lose.
|
||||
|
||||
## Step 1: Take some Backups
|
||||
|
||||
First take some backups:
|
||||
|
||||
- Make a copy of `~/.var/app/net.retrodeck.retrodeck/` folder and name it `old.net.retrodeck.retrodeck`
|
||||
- Make a full back up or partial backups of the retrodeck folder normally under `~/retrodeck` or sdcard/other drive.
|
||||
|
||||
**On retrodeck folder backups:**
|
||||
|
||||
Generally, very few things would target the roms folder, but the other folders could be targeted for various scripts. Our recommendation would be to back up the full `~/retrodeck` folder, but as a tester you can decide how much you want to risk.
|
||||
|
||||
**Disclamer:**
|
||||
|
||||
The RetroDECK Team also had never had any major data loss so far and we do Cooker updates almost daily.
|
||||
|
||||
## Step 2: Download the Cooker
|
||||
|
||||
- Download the latest Cooker release from: [RetroDECK Cooker: Latest](https://github.com/XargonWan/RetroDECK-cooker/releases/latest) to your download folder.
|
||||
- Make a note of the `<version_id>` that is a randomly generated word, example: `cooker-X.X.Xb-HelloWorld`, in this example it's `HelloWorld`.
|
||||
|
||||
## Step 3: Terminal
|
||||
|
||||
Open the terminal window.
|
||||
|
||||
### Remove and Install
|
||||
|
||||
- `flatpak remove net.retrodeck.retrodeck` and press (y) yes to remove RetroDECK. If you have more then one version installed for some reason choose to remove all versions.
|
||||
- `flatpak install --user --bundle --noninteractive -y "~/Downloads/RetroDECK-cooker.flatpak"` this will install RetroDECK Cooker.
|
||||
|
||||
## Step 4: Upgrade
|
||||
|
||||
🛑 **IMPORTANT WARNING:** 🛑
|
||||
|
||||
Under **NO** circumstances press the `Full Wipe and Fresh Install` button.
|
||||
|
||||
That is **NOT** to be confused with Configurators `Reset RetroDECK` option.
|
||||
|
||||
This in fact a `Nuke Everything` option for reseting everything to a clean slate. It will remove all of RetroDECK including all ROMS/BIOS/Downloaded Media and everything else you have in RetroDECK's folders...forever.
|
||||
|
||||
You will get several warnings if you accidentally press it.
|
||||
|
||||
### Upgrading RetroDECK
|
||||
|
||||
- After the installation is complete type: `flatpak run --command=sh net.retrodeck.retrodeck` followed by `retrodeck`.
|
||||
- Press the `Upgrade` button and keep the installation moving until all the steps are complete and RetroDECK will launch.
|
||||
- Quit RetroDECK again and save all the output from the terminal into a text file.
|
||||
|
||||
|
||||
|
||||
## Step 5: Start testing
|
||||
|
||||
If you are on `SteamOS` like on the Steam Deck return to `Game Mode` for this step.
|
||||
|
||||
If you are on `Linux Desktop` make sure you launch RetroDECK via Steam, else Steam Input won't work.
|
||||
|
||||
Now feel free to test all the new features of the update and report any issues, check the patch notes for what is new.
|
||||
|
||||
All logs will be saved in the new `retrodeck/logs` folder
|
||||
|
||||
Thank you! ❤️
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
# What are RetroDECK experimental features?
|
||||
|
||||
The main function of the experimental features is for the RetroDECK team to do some light testing in the stable environment.
|
||||
|
||||
Experimental features are a showcase of what proof-of-concepts we are trying out.
|
||||
|
||||
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.
|
||||
|
||||
## 🛑 Backup before testing! 🛑
|
||||
These features can make you loose all data including `ROMS`, `BIOS` and `Scraped Data` etc..<br>
|
||||
|
||||
We **recommend** that you don't run any cooker builds on your main gaming machine as you daily usage of RetroDECK.
|
||||
|
||||
### 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/`
|
||||
|
||||
## How do I enable experimental features?
|
||||
|
||||
From CLI run:
|
||||
|
||||
`flatpak run net.retrodeck.retrodeck uuddlrlrstart`
|
||||
|
||||
The `Developer Options Menu` should show up inside the Configurator.
|
||||
43
wiki-rtd/docs/wiki_development/testing/faq-cooker.md
Normal file
43
wiki-rtd/docs/wiki_development/testing/faq-cooker.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# RetroDECK Cooker - FAQ
|
||||
|
||||
## 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.
|
||||
|
||||
Cooker is a bleeding edge snapshot of the current commits, the action of uploading code to GitHub is called commit.
|
||||
|
||||
The code may not be always reviewed and so the cooker it's unstable by its nature, it's just suggested to testers or developer to try bleeding edge functions.
|
||||
|
||||
We don't support the cooker on user side.
|
||||
|
||||
### Why the name cooker? 🍲
|
||||
|
||||
That's what cooking in the pot at this moment and not yet ready to be served (released). This name was also used by Linux Mandrake and Mandriva for the bleeding edge channel.
|
||||
|
||||
### Why does the cooker releases have strange names?
|
||||
|
||||
The names are randomly generated to make it easy to see what build you are running.
|
||||
|
||||
## Can I help you with testing?
|
||||
|
||||
Yes, post in the `💙-i-want-to-help` on our [Discord](https://discord.gg/WDc5C9YWMx) or [Matrix](https://matrix.to/#/#retrodeck:matrix.org) that you want to help with testing cooker builds.
|
||||
|
||||
Anyone can always download the cooker builds without telling the team as they are open to all, but we recommend that you do the RetroDECK team and flag yourself as a tester as the RetroDECK team can support you.
|
||||
|
||||
## How do I start with testing?
|
||||
|
||||
Read the [Cooker Testing - Guide](../cooker-testing.md)
|
||||
|
||||
## How do I upgrade from Cooker to Cooker?
|
||||
|
||||
You can update via the cooker auto-updater prompt when you launch RetroDECK-Cooker, how ever the Cooker auto updater might be break during testing and in such cases download the latest release from the [RetroDECK Cooker](https://github.com/XargonWan/RetroDECK-cooker) GitHub.
|
||||
|
||||
After doing the upgrade make sure you are on the right Cooker version via the ES-DE menu.
|
||||
|
||||
**Note:**
|
||||
|
||||
Always try stay on the latest Cooker release before reporting any bugs.
|
||||
|
||||
## How do I uninstall RetroDECK Cooker?
|
||||
|
||||
Just go into your application manager/installer (like Discover), find RetroDECK and press uninstall or via the terminal run the following command: `flatpak remove RetroDECK`
|
||||
|
|
@ -1,81 +0,0 @@
|
|||
# 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 --user --bundle --noninteractive -y RetroDECK-cooker.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.
|
||||
|
||||
## Debug Mode
|
||||
|
||||
Read more over at [Debug Mode](../general/debug-mode.md).
|
||||
|
|
@ -1,119 +0,0 @@
|
|||
# Release Candidate: Cooker Testing
|
||||
|
||||
If you are on `SteamOS` like on the Steam Deck make sure you are in `Desktop Mode` before you begin.
|
||||
|
||||
### Do not use the the Rowan Skye Method
|
||||
|
||||
We do not recommend to blindly install the Cooker without reading this guide and follow the instructions. To just install and hope for the best is the `Rowan Skye Method`. <br>
|
||||
This is only recommended for chaotic blue draconic wolfkin testers living on the edge with nothing to lose.
|
||||
|
||||
## Step 1: Take some Backups
|
||||
|
||||
First take some backups:
|
||||
|
||||
- Make a copy of `~/.var/app/net.retrodeck.retrodeck/` folder and name it `old.net.retrodeck.retrodeck`
|
||||
- Make a full back up or partial backups of the retrodeck folder normally under `~/retrodeck` or sdcard/other drive.
|
||||
|
||||
**On retrodeck folder backups:**
|
||||
|
||||
Generally, very few things would target the roms folder, but the other folders could be targeted for various scripts. Our recommendation would be to back up the full `~/retrodeck` folder, but as a tester you can decide how much you want to risk.
|
||||
|
||||
**Disclamer:**
|
||||
|
||||
The RetroDECK Team also had never had any major data loss so far and we do Cooker updates almost daily.
|
||||
|
||||
## Step 2: Download the Cooker
|
||||
|
||||
- Download the latest Cooker release from: [RetroDECK Cooker: Latest](https://github.com/XargonWan/RetroDECK-cooker/releases/latest) to your download folder.
|
||||
- Make a note of the `<version_id>` that is a randomly generated word, example: `cooker-X.X.Xb-HelloWorld`, in this example it's `HelloWorld`.
|
||||
|
||||
## Step 3: Terminal
|
||||
|
||||
Open the terminal window.
|
||||
|
||||
### Remove and Install
|
||||
|
||||
- `flatpak remove net.retrodeck.retrodeck` and press (y) yes to remove RetroDECK. If you have more then one version installed for some reason choose to remove all versions.
|
||||
- `flatpak install --user --bundle --noninteractive -y "~/Downloads/RetroDECK-cooker.flatpak"` this will install RetroDECK Cooker.
|
||||
|
||||
## Step 4: Upgrade
|
||||
|
||||
**IMPORTANT:**
|
||||
|
||||
Under **NO** circumstances press the `Full Wipe and Fresh Install` button. That is **NOT** to be confused with Configurators `Reset RetroDECK` option. This in fact a `Nuke Everything` option, it will remove all of RetroDECK including all ROMS/BIOS/Downloaded Media and everything else you have in RetroDECK's folders...forever.
|
||||
|
||||
### Upgrading RetroDECK
|
||||
|
||||
- After the installation is complete type: `flatpak run --command=sh net.retrodeck.retrodeck` followed by `retrodeck`.
|
||||
- Press the `Upgrade` button and keep the installation moving until all the steps are complete and RetroDECK will launch.
|
||||
- Quit RetroDECK again and save all the output from the terminal into a text file.
|
||||
|
||||
### Upgrading from Cooker to Cooker.
|
||||
|
||||
Always stay on the latest Cooker release, note that the Cooker auto updater might be bug out sometimes. It might be better just to download the latest Cooker file github.
|
||||
|
||||
After doing the upgrade make sure you are on the right Cooker version via the ES-DE menu.
|
||||
|
||||
Minor releases are released to fix reported issues / bugs.
|
||||
|
||||
If a new minor release is out test if the issues are still there and if they are report to the RetroDECK Team via the Beta-Testing channel on discord.
|
||||
|
||||
You can always follow the lastest Cooker releases there as well, with direct links to download them.
|
||||
|
||||
---
|
||||
|
||||
## 0.8.0b upgrade & testing
|
||||
|
||||
Check the [0.8.0b Patch Notes](../../wiki_rd_versions/version_0.8.0b/0.8.0b.md) for all the changes.
|
||||
|
||||
### When upgrading from 0.7.6b Stable to 0.8.0b Cooker
|
||||
|
||||
**IMPORTANT:**
|
||||
|
||||
Check for the message `"In version 0.8.0b, the following changes were made that required config file updates/reset or other changes to the filesystem:"` in the terminal. This is a sign that tell you the post update migration is running, this is crucial for RetroDECK's upgrade to fully happen.
|
||||
|
||||
This is what should happend in the post migration.
|
||||
|
||||
```
|
||||
- Remove any of the following files, if they exist:
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_config.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_generic_standard.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_ps3_dualshock3.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_ps4_dualshock4.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_ps5_dualsense.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_steam_controller_gordon.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_neptune.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_switch_pro.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_xbox360.vdf"
|
||||
"$HOME/.steam/steam/controller_base/templates/RetroDECK_controller_xboxone.vdf"
|
||||
- The line "[nintendo_button_layout]" should be renamed "[abxy_button_swap]" in retrodeck.cfg
|
||||
- The folder "/var/config/emulationstation" should be renamed to "/var/config/ES-DE" (internal Flatpak paths)
|
||||
- ES-DE should be put through a reset process (verify via logs)
|
||||
- MAME should be put through a reset process (verify via logs)
|
||||
- Vita3K should be put through a reset process (verify via logs)
|
||||
- GZDOOM should be put through a reset process (verify via logs)
|
||||
- If the folder ~/retrodeck/.logs exists, it should be renamed to ~/retrodeck/logs
|
||||
- The RPCS3 saves should be migrated by the following steps:
|
||||
- The folder ~/retrodeck/backups should be created if it doesn't already exist
|
||||
- A backup of current RPCS3 save data should be created at ~/retrodeck/backups/(date and time backup started)_rpcs3_save_data.zip
|
||||
- The symlink and real folders for save data should be switched:
|
||||
- The folder at ~/retrodeck/saves/ps3/rpcs3 should now be real
|
||||
- The folder at ~/retrodeck/bios/rpcs3/dev_hdd0/home/00000001/savedata should now be a symlink back to ~/retrodeck/saves/ps3/rpcs3
|
||||
- Rename the folder ~/retrodeck/bios/switch/registered to ~/retrodeck/bios/switch/firmware
|
||||
- Default ROMs folders should be recreated by ES-DE to add new systems
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Step 5: Start testing
|
||||
|
||||
If you are on `SteamOS` like on the Steam Deck return to `Game Mode` for this step.
|
||||
|
||||
If you are on `Linux Desktop` make sure you launch RetroDECK via Steam, else Steam Input won't work.
|
||||
|
||||
Now feel free to test all the new features of the update and report any issues, check the patch notes for what is new.
|
||||
|
||||
All logs will be saved in the new `retrodeck/logs` folder
|
||||
|
||||
Thank you! ❤️
|
||||
|
|
@ -6,18 +6,6 @@
|
|||
|
||||
It stands for Beta.
|
||||
|
||||
## What is RetroDECK cooker?
|
||||
|
||||
Cooker is a bleeding edge snapshot of the current commits, the action of uploading code to GitHub is called commit.
|
||||
|
||||
As you can understand, the code may not be always reviewed and so the cooker it's unstable by its nature, it's just suggested to testers or developer to try bleeding edge function or to contribute.
|
||||
|
||||
More info on the pinned post in #💙-i-want-to-help on our [Discord Server](https://discord.gg/WDc5C9YWMx).
|
||||
We don't support the cooker on user side.
|
||||
|
||||
### Why the name cooker? 🍲
|
||||
That's what cooking in the pot at this moment and not yet ready to be served (released). This name was also used by Linux Mandrake and Mandriva for the bleeding edge channel.
|
||||
|
||||
## What emulators and software is included in RetroDECK?
|
||||
Check: [RetroDECK: What's included?](../wiki_about/what-is-included.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -321,8 +321,9 @@ nav:
|
|||
- Add System (WIP): wiki_development/general/add-system.md
|
||||
|
||||
- Testing 📝:
|
||||
- How do I help out with testing?: wiki_development/testing/general-testing.md
|
||||
- Release Candidate Testing: wiki_development/testing/release-candidate-testing.md
|
||||
- Cooker Testing - FAQ: wiki_development/testing/faq-cooker.md
|
||||
- Cooker Testing - Guide: wiki_development/testing/cooker-testing.md
|
||||
- Expermental Features: wiki_development/testing/experimental-features.md
|
||||
|
||||
- Archive 🗃️:
|
||||
- Yuzu 🔴 (Archive):
|
||||
|
|
|
|||
Loading…
Reference in a new issue