Wiki/wiki-rtd/docs/wiki_development/testing/release-candidate-testing.md

120 lines
6.2 KiB
Markdown
Raw Normal View History

2024-03-30 10:18:07 +00:00
# Release Candidate: Cooker Testing
2024-03-30 08:16:36 +00:00
2024-03-31 08:19:55 +00:00
If you are on `SteamOS` like on the Steam Deck make sure you are in `Desktop Mode` before you begin.
2024-03-30 16:35:26 +00:00
2024-03-31 08:32:21 +00:00
### Do not use the the Rowan Skye Method
2024-03-31 07:25:44 +00:00
2024-03-31 08:32:21 +00:00
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>
2024-03-31 07:25:44 +00:00
This is only recommended for chaotic blue draconic wolfkin testers living on the edge with nothing to lose.
2024-03-30 08:16:36 +00:00
## 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`
2024-03-30 10:09:37 +00:00
- Make a full back up or partial backups of the retrodeck folder normally under `~/retrodeck` or sdcard/other drive.
2024-03-31 07:31:29 +00:00
**On retrodeck folder backups:**
2024-03-30 10:09:37 +00:00
2024-03-31 07:31:29 +00:00
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.
2024-03-30 10:09:37 +00:00
2024-03-30 16:43:18 +00:00
**Disclamer:**
2024-03-30 10:09:37 +00:00
2024-03-31 08:46:45 +00:00
The RetroDECK Team also had never had any major data loss so far and we do Cooker updates almost daily.
2024-03-30 08:16:36 +00:00
## Step 2: Download the Cooker
2024-03-31 08:46:45 +00:00
- Download the latest Cooker release from: [RetroDECK Cooker: Latest](https://github.com/XargonWan/RetroDECK-cooker/releases/latest) to your download folder.
2024-03-31 07:37:34 +00:00
- 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`.
2024-03-30 08:16:36 +00:00
## Step 3: Terminal
2024-03-30 10:18:07 +00:00
Open the terminal window.
2024-03-30 08:16:36 +00:00
2024-03-30 10:18:07 +00:00
### 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.
2024-03-30 10:09:37 +00:00
- `flatpak install --user --bundle --noninteractive -y "~/Downloads/RetroDECK-cooker.flatpak"` this will install RetroDECK Cooker.
2024-03-30 10:18:07 +00:00
2024-03-30 16:43:18 +00:00
## Step 4: Upgrade
2024-03-30 08:16:36 +00:00
2024-03-30 10:09:37 +00:00
**IMPORTANT:**
2024-03-30 16:43:18 +00:00
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.
2024-03-30 10:18:07 +00:00
2024-03-31 08:46:45 +00:00
### Upgrading RetroDECK
2024-03-30 10:18:07 +00:00
2024-03-30 16:43:18 +00:00
- 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.
2024-03-30 10:18:07 +00:00
2024-03-31 08:46:45 +00:00
### 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.
2024-03-31 07:31:29 +00:00
---
## 0.8.0b upgrade & testing
2024-03-30 08:16:36 +00:00
2024-03-31 08:46:45 +00:00
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
2024-03-30 10:09:37 +00:00
**IMPORTANT:**
2024-03-30 16:43:18 +00:00
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.
2024-03-30 10:09:37 +00:00
2024-03-30 16:43:18 +00:00
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
```
2024-03-31 07:37:34 +00:00
2024-03-31 08:46:45 +00:00
2024-03-31 07:31:29 +00:00
---
2024-03-30 08:16:36 +00:00
## Step 5: Start testing
2024-03-31 08:19:55 +00:00
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.
2024-03-30 08:16:36 +00:00
2024-03-31 07:37:34 +00:00
Now feel free to test all the new features of the update and report any issues, check the patch notes for what is new.
2024-03-30 08:16:36 +00:00
All logs will be saved in the new `retrodeck/logs` folder
Thank you! ❤️