blooym / proto Goto Github PK

Install and manage custom runners with ease on supported systems.

View Issues · Install · Contributing

Proto is a command line tool designed to make it easier to manage custom runner installations (eg. Proton-GE) without the need to manually navigate the filesystem or extract tar files when a new build is released.

• The ability to add multiple runner release sources (GitHub only, must ship the runner in a .tar format)
• The ability to bind directories to keywords so you don't have to remember or type them every time (ig. steam -> ~/.steam/root/compatabilitytools.d)
• The ability to pull information about any release directly from GitHub
• Powerful but minimal configuration (which is stored in a very portable format)
• Fully documented through the command line using the -h flag after any command
• Shell completion for bash, fish, powershell and zsh (via the completion command)
• A built in app-updater for manual binary installs
• Responsive & easy to use
• Checksum validation (sha512sum only)

Proto is fully documentated from the command line by using the -h flag after any command, which includes usage examples and a full list of flags/arguments. A basic installation from Source #1 to the Steam directory would look like:

proto install --dir steam --source 1

You can tweak the configuration for Proto by running the following:

proto config

Proto currently requires the following packages in order to function: tar

Manually download a release file from the GitHub releases.

Build Proto directly from the source for your system. Only recommended for advanced users that prefer to build from source or contributors.