Metadata-Version: 2.1
Name: protonup
Version: 0.0.2
Summary: Manage Proton-GE Installations
Home-page: https://github.com/AUNaseef/protonup
Author: Naseef
License: GPL-3.0
Platform: UNKNOWN
Requires-Python: >3.6
Description-Content-Type: text/markdown
Requires-Dist: requests

## Introduction
CLI program and API to automate installation of [GloriousEggroll](https://github.com/GloriousEggroll/)'s [Proton-GE](https://github.com/GloriousEggroll/proton-ge-custom)

## Installation
 Install from Python Package Index
```
pip install protonup
```
Install from source
```
git clone https://github.com/AUNaseef/protonup && cd protonup
python3 setup.py install
```

## Usage
Set your installation directory before running the program with `-d "your/compatibilitytools.d/directory"`

Example:
```
protonup -d "~/.steam/root/compatibilitytools.d/"
```
---
To update to the latest version, just run `protonup` from a command line

Example:
```
protonup
```
---
Install a specific version with `-t "version tag"`

Example:
```
protonup -t 6.5-GE-2
```
---
By default the downloads are stored in a temporary folder. Change it with `-o "custom/downlod/directory"`

Example:
```
protonup -o ~/Downloads
```
---
List existing installations with `-l`

Example:
```
protonup -l
```
---
Remove existing installations with `-r "version tag`

Example:
```
protonup -r 6.5-GE-2
```
---
Use `--download` to download  Proton-GE to the current working directory without installing it, you can override destination with `-o`

Example:
```
protonup --download
```
---
Use `-y` toggle to carry out actions without any logging or interaction

Example:
```
protonup --download -o ~/Downloads -y
```
---
### Restart Steam after making changes


