Important
Scripts from this repo are free and open source. If someone asks you to pay for them, it's likely a scam.
It's a shell script for lazy people like me who want to use BTRFS formatted microSD cards on their decks, but don't want to type many commands into a command line. If you're one of us, worry no more as I got you covered.
Despite that it's simple, you're still using it at your own risk. I've tried my best to make it foolproof and always run tests before release until I consider it stable, but some things may show up only after long use. You've been warned.
There are other repositories like mine. They are based on replacing entire scripts with the ones already patched. My approach is to patch the original scripts directly using a small patch file. My tool also lets you perform a reverse patch (unpatch) operation on the patched scripts or create a backup of the original scripts so they can be restored later (restore backup).
Everything has been well explained in the btrfdeck repository by Trevo525. Instead of copy-pasting everything from there here and thus committing plagiarism, I will just encourage you to go there and read the original content of that repo.
There are two ways to install this tool: Automatic or Manual [PRO].
The automatic installation script will download and install the latest version of this tool in the 'DOCUMENTS' directory and create a shortcut on 'DESKTOP'.
To install this way, open a new Konsole window and paste one of the following lines of code depending on what you want to do:
curl -sSL https://raw.githubusercontent.com/mi5hmash/SteamDeckBTRFS/main/_Installer.sh | bashcurl -sSL https://raw.githubusercontent.com/mi5hmash/SteamDeckBTRFS/main/_Installer.sh | bash -s -- -uGrab the latest release and unpack it on your Steam Deck. Then right-click on the '_Create a Shortcut on Desktop.sh' and select "Properties". Navigate to the "Permissions" tab and make sure that an "Is executable" checkbox is ticked.
Then click OK and once again right-click on the '_Create a Shortcut on Desktop', but this time select "Run in Konsole". You can also click twice and execute that script.
A desktop shortcut will be created.
Regardless of which installation method you choose, you should end up with a shortcut on your desktop. Run the script with it.
Do not attempt to execute 'SteamDeckBTRFS.sh' by clicking twice on it, because this will run the script in a hidden window.
Do not click on 'Add to Steam' and try to execute 'SteamDeckBTRFS.sh' from the Gaming Mode. It's meant to be run from the desktop.
Starting from version 1.1.0, the script checks on each launch if a newer release is available. If so, it asks the user for permission to download and update the tool. Next, the script will check if there is a patch for the current build of the system in the "./patches/" directory. If the tool doesn't find a suitable candidate, it tries to look for it online in this repository and download it on your device.
Although nearly all of the names are self-explanatory, I'm leaving a short note below each one of them.
Safely terminates the script.
Tries to patch or reverse patch the scripts on Steam Deck if a compatible patch exists in the "./patches/" directory. Before doing so you would want to run "2. Backup scripts" option just in case you need it later.
Important
Unpatch option works only when the scripts were previously patched by this tool.
Makes a backup of script files and stores it in the "./backup/" directory.
Restores a backup selected from a "./backup/" directory.
Hidden functions
You can make the program display these options in the main menu by setting the "SHOW_HIDDEN_OPTIONS" flag to "1" in the "settings.json" file.
Allows you to change the steamos-readonly status to the opposite of the current one.
Unpacks a previously made backup to the "./workbench/original/" directory and copies script files to the "./workbench/patched/" directory. Having all that set, you can try to make a change to the scripts inside the "./workbench/patched/" directory.
Note
There are additional files in the "./workbench/org_intel/" directory that are not needed to create the patch, but may be helpful.
After you change everything you want, you can run this option to compare files from both directories and get your own patch as a result. The file will be saved in the "./patches/" directory.
Warning
You have to run it from a SteamOS on a Steam Deck as it will take the current SteamOS build as a patch version. Using other Linux distros won't work.
After completion of each function, you will be asked if that's all for now. You can choose 'No' to come back to the list of all functions.
A majority of options require root privileges. If you've already set your custom password, the script will ask you to type it. It will be stored as an encrypted variable for the time of running the script. Otherwise, the script will use the default password which is "GabeNewell#1". Unless you're using your own password, it will be removed at the end of each option execution.
By default, remembering the user's custom password is disabled. You can change it by setting the "REMEMBER_PASSWORD" flag to "1" in the "settings.json" file. After the change, the script will remember the next entered password and save it in the encrypted ".user.sec" file.
The tool uses the data from the "./patches/_patches.csv" file to identify the correct patch. Info about patches created with a workbench is added to the "./patches/_patches_own.csv" file. That file overrides data from the first mentioned file. The structure of both files is as follows:
e4765353a6fe36f254e67a3f7c62719e;b5ce0513-9d81-4c16-b7f9-c3b3fa2cee16;O
9d212ba6f4e7afce19d8eb3a836065af;b5ce0513-9d81-4c16-b7f9-c3b3fa2cee16;Pmd5 checksum of sha256 checksums of the script files separated by a "|" character;random GUID which is used as patch filename;letter "P" (Patched) or "O" (Original)
| Build | Mounting options |
|---|---|
| < 20221221.2 | compress-force=zstd:15 |
| >= 20221221.2 | compress-force=zstd:6, lazytime, space_cache=v2, ssd_spread |
| >= 20231116.2 | compress-force=zstd:6, lazytime, space_cache=v2 |
| Build | Mounting options |
|---|---|
| >= 20231116.2 | windows_names, lazytime, big_writes |
| >= 20240626.100 | windows_names, lazytime |
All the problems I've encountered during my tests have been fixed on the go. If you find any other issue (hope you won't) then please, feel free to report it there.
Trevo525 - he did great research and his repository is a mine of information.
Sources: