Skip to content
This repository has been archived by the owner on Aug 19, 2022. It is now read-only.

Latest commit

 

History

History
126 lines (103 loc) · 9.82 KB

README.md

File metadata and controls

126 lines (103 loc) · 9.82 KB
Raw

Why is this repo archived?

I tested a different version of this script. Though it may not have as cool of a name, it is easier to use, more actively developed, and offers a /home conversion as well! So, after testing on my own Deck, I have decided to archive my repo with a link to theirs. If you like this version better, feel free to fork it. If you just want to use btrfs, use this: SteamOS Btrfs

btrfdeck - (butter-f-deck)

Improve your Steam Deck with eight simple steps!

The instructions and files on this page are designed to help you format microSD cards for your Steam Deck with BTRFS. This can lead to tremendous storage space savings and even faster loading performance.

This process involves changing two files in the protected SteamOS partition, which will allow you to format your card more easily and then enable the Deck to automatically mount the card with compression-on-write on insert!

But why?

Great question. There are three reasons why you would want to do this.

  1. Saving storage space: btrfs allows you to apply compression directly to the file system. This can save as much as 40% of space on games. But don't take my word for it. Another storage saving thing that btrfs allows is de-duplication. I haven't looked into this much so I haven't implement it yet but I read that there is a lot of redundant data in Proton prefixes.
  2. Faster loading times: In my experience with the deck (limited), loading from the microSD card has not been bad. However, microSD is going to be the bottleneck of loading many bigger games because it has only so much bandwidth. If compression saves you ~40% of storage then that means you have 40% less data to load from the microSD, since it's decompressed AFTER being loaded from the card. There is another reddit thread with more tests, it has a small sample size (tested on one game) but it still looks positive for using compression at the file system level.
  3. Cross-OS compatibility: This is something I never considered when making this but thanks to The Phawx's Video you can see that with the Open-Source BTRFS Windows Driver you can use the same microSD Steam Library accross SteamOS and Windows.
    • Warning! The video only shows one game. I saw in the comments from people experienced with this exact thing on other Linux distros, that many games have different versions on Windows vs Linux (Think Linux Native vs Proton ports). What this might result in is every time you change form one OS to another, it might redownload one or many of your games to match the OS you are currently running. If you intend to try this, I would be aware of this and if a game does this, be sure to remove those games from the shared library.

Why not?

The are two arguments that might suggest that this isn't a good idea.

  1. Adding compression/decompression will decrease your battery's runtime since it's more work for your CPU.
    • Though that is definetely true, I would argue that the amount that it might decrease would be so small you that it wouldn't even be noticable. I don't know of any tests that have shown how much it affects the power usage, but will update here when I find one. :-D
  2. Changing files in the read-only partition is risky.
    • This is also true. Don't do it if you don't know what you are doing. It can however be done without editing anything in the readonly partition. You just have to go in and mount it via desktop mode at every boot and insertion.

What is changed?

There are two files from the Steam Deck that handle mounting and formatting a microSD card formatted with btrfs. Both of these files are located in the /usr/lib/hwsupport/ directory. I copied them to ./unmodified and ./modified here in this repository and edited in the modified folder.

sdcard-mount.sh

This script is called when a microSD card is inserted in the slot on the Deck. You can compare the version in /modified to /unmodified to see exact what I changed but I will summarize the two changes to this file below.

if [[ ${ID_FS_TYPE} != "ext4" && ${ID_FS_TYPE} != "btrfs" ]]; then
  exit 1
fi

This was already in the file but I added && ${ID_FS_TYPE} != "btrfs". The if statement without this addition says to not automatically mount anything that is not the filesystem type ext4. The addition adds btrfs to the list, simply not closing this script if the drive is formatted with btrfs.

if [[ ${ID_FS_TYPE} == "btrfs" ]]; then
    OPTS+=",compress-force=zstd:15"
fi

The block above was added and not just changed like the previous one. This section means that if filesystem is btrfs add the zstd compression with a level of 15 to the mounting options. I selected 15 as the compression level but I am open to change that if someone provides a good reason to. :-)

format-sdcard.sh

When you press the "Format SD Card" button in the Steam Deck UI it calls this script. Below is the change I made.

# mkfs.ext4 -m 0 -O casefold -E "$EXTENDED_OPTIONS" -F "$SDCARD_PARTITION"
mkfs.btrfs -f "$SDCARD_PARTITION"

The top line is commented out, that's what the '#' symbol means. The second line is my replacement that formats with btrfs.

Guide:

1. Download this project to your home directory of the deck.

cd ~
git clone https://github.com/Trevo525/btrfdeck
cd btrfdeck

2. Setup deck user with a password so that you can run things that need sudo.

passwd deck

3. Backup the old script.

mkdir ./backup/
cp /usr/lib/hwsupport/sdcard-mount.sh ./backup/sdcard-mount.sh
cp /usr/lib/hwsupport/format-sdcard.sh ./backup/format-sdcard.sh

4. Change the filesystem to read-write so that you can make changes to the protected files.

NOTE: this makes your entire "SteamOS" partition read-write. Basically, removing all barriers keeping you from breaking your system. You've been warned.

sudo steamos-readonly disable

5. Replace with modified configs.

sudo rm /usr/lib/hwsupport/sdcard-mount.sh && sudo rm /usr/lib/hwsupport/format-sdcard.sh
sudo cp ./modified/sdcard-mount.sh /usr/lib/hwsupport/sdcard-mount.sh
sudo cp ./modified/format-sdcard.sh /usr/lib/hwsupport/format-sdcard.sh
sudo chmod 755 /usr/lib/hwsupport/sdcard-mount.sh /usr/lib/hwsupport/format-sdcard.sh

6. Change the filesystem back to read-only so that you can no longer make changes to the protected files.

sudo steamos-readonly enable

7. Remove the password from the deck user. (Skip this and next step to use btrfdeck_post_update.sh to re-run steps 3-6 after an OS update)

sudo passwd -d deck

8. Format the SD card.

Press the "Format SD Card" button in the Steam Deck UI.

At this point it should automatically mount the drive because both files were changed. If it does not here is how I would troubleshoot:

  • Try ejecting the microSD card and reinserting. (Sometimes it'll take a few seconds to mount a large drive.)
  • Restart Steam.
  • Go to the desktop and check if it is mounted.
  • If that doesn't work, try to format in the SteamUI again. I need to figure out where this logs to so I can add that here.
  • You could try formatting manually, either through KDE Partition Manager or though the terminal.
  • Lastly, if all else fails, you can follow the Undo the changes section below to make it as if you never made a change.

After a SteamOS update

Don't remove password and run the btrfdec_post_update.sh script by right-clicking it and selecting "Run in Konsole".

Undo the changes:

1. Setup deck user with a password.

passwd deck

2. Change the filesystem to read-write.

sudo steamos-readonly disable

3. restore from the backup.

sudo rm /usr/lib/hwsupport/sdcard-mount.sh && sudo rm /usr/lib/hwsupport/format-sdcard.sh
cp ./backup/sdcard-mount.sh /usr/lib/hwsupport/sdcard-mount.sh
cp ./backup/format-sdcard.sh /usr/lib/hwsupport/format-sdcard.sh

4. Change the filesystem back to read-only.

sudo steamos-readonly enable

5. Remove the password from the deck user.

sudo passwd -d deck

Issues

I don't know how to quantify some of the weird issues I am having so just know this isn't perfect but after I've tested it for a little while longer I'll leave some more notes here. If you try this and you have any issues feel free to leave an issue here.

Credits

Thanks to u/ClinicallyInPain on reddit for compiling some of the resources and to u/Hanntac and u/leo_vir for their contributions! Both of the last two credits helped me through PM so I am incredibly thankful for the both of them. Also to u/sporkyuncle for helping me make it more user-friendly.

The following Github users:

Sources: