Protonup-rs

Lib, CLI and GUI(wip) program to automate the installation and update of Linux Gaming Compatibility tools, like ProtonGE, Luxtorpeda, Boxtron and others.

NOTE: This has no relations with the original ProtonUp project, and I thankful for the original author.

I've create it because the original project had a few issues with its Python dependencies (that most likely got fixed already). I wanted to to re-create it in rust, in a way it could be used as a lib and a CLI.

Currently supported tools

These are the tools that are currently supported by this project.

Adding new tools should be a simple process, check the docs section below!

Usage

Interactive TUI Mode

The default way is to simply invoke the cli, and navigate the text interface.

protonup-rs

CLI Mode (Non-Interactive)

For automation or scripting, you can use CLI arguments to skip the TUI:

# Install latest GEProton for Steam (auto-detected)
protonup-rs --tool GEProton

# Install specific version for Lutris
protonup-rs --tool GEProton --version 8.26 --for lutris

# Install to custom path
protonup-rs --tool GEProton --version latest --for ~/.local/steam

# Force overwrite existing installation
protonup-rs --tool GEProton --for steam --force

CLI Options

Options:
  -q, --quick-download     Skip Menu, auto detect apps and download using default parameters
  -f, --force              Force install for existing apps during quick downloads
      --tool <TOOL>        Compatibility tool to install (e.g., GEProton, Luxtorpeda)
      --version <VERSION>  Version to install (use "latest" for the latest version)
      --for <FOR>          Target for installation. Use "steam", "lutris", or a custom path. If omitted, auto-detects based on tool compatibility
  -h, --help               Print help

--for argument behavior:

• steam / Steam - Install to Steam (Native or Flatpak)
• lutris / Lutris - Install to Lutris (Native or Flatpak)
• <path> - Any other value is treated as a custom installation path
• Omitted - Auto-detects based on the tool's compatible applications and what's installed

Installing (Available for x86 and ARM !)

Clickable download (Steam Deck Friendly)

• download .desktop file
• drag the file from the Downloads folder to your desktop
• run it (double click)
• open a new terminal window to run protonup-rs

Click Here to Download installer

NOTE: This will download a simple ".desktop" file that will download the pre-compiled binary from release, decompress it, place it in "$HOME/.local/bin/", and add this folder to your PATH.

In one line

Does the same as the installer above, but from the command line

sh -c 'ARCH=$(uname -m | sed "s/x86_64/amd64/;s/aarch64/arm64/"); FILE="protonup-rs-linux-$ARCH.tar.gz"; if curl -S -s -L -O --output-dir /tmp/ --connect-timeout 60 "https://github.com/auyer/Protonup-rs/releases/latest/download/$FILE" ; then tar -xvzf "/tmp/$FILE" -C /tmp/ && mkdir -p ${HOME}/.local/bin && mv /tmp/protonup-rs ${HOME}/.local/bin/ && (echo "$SHELL" | grep -q "bash" && echo "export PATH=\"\$PATH:${HOME}/.local/bin\"" >> ${HOME}/.bashrc || echo "$SHELL" | grep -q "zsh" && echo "export PATH=\"\$PATH:${HOME}/.local/bin\"" >> ${HOME}/.zshrc); rm "/tmp/$FILE"; else echo "Something went wrong, please report this if it is a bug"; read; fi'

This assumes /usr/bin is in your path. You may change this to any other location (in your path echo $PATH).

Or manually

The instructions below refer to amd64 (x86) release. If using ARM, just replace with arm64. Get the latest binary:

Most devices (Intel, AMD, Steam Deck...): Download link (x86)

if using arm (raspberry pi, phones, Asahi users, Qualcomm laptop...): Download link (ARM64)

It is a single binary. You can just run it, or add it to your path so you can call it from anywhere.

Quick way to add it to your path: or download the zip from the releases page

cd Downloads
sudo unzip protonup-rs-linux-amd64.zip -d /usr/bin

Building from source

You can install from source using the last released version in Crates.io:

cargo install protonup-rs

Or clone repo:

cd protonup-rs
cargo build -p protonup-rs --release
mv ./target/release/protonup-rs "your path"

Docs

Code docs available in the docs/docs.md file, and default generated docs in docs.rs/libprotonup.

Roadmap

1. GUI: Not ready for usage. I made a few experiments with different libs, and decided to use the iced/cosmic framework. I left the base structure, and hope to get to it someday or to receive contributions.

Feedbacks & Contributing

This project accepts contributions and feedbacks from anyone. For feedbacks, please use GitHub Issues or Discussions. Please be polite (code-of-conduct).

For contributions, there aren't many rules. Just try to justify your changes, and try to make the pull request easy to review. Is is very recommended to add tests, specially for complex code. Thanks!

Roles and Maintainers

This project is maintained only by the creator @auyer

Maintaining this project does not take a lot of effort. The project is open to having other contributors, specially if implementing a GUI.