https://github.com/jegj/protondb-cli

A unofficial CLI for protondb project
https://github.com/jegj/protondb-cli

cli nodejs protondb

Last synced: 4 months ago
JSON representation

A unofficial CLI for protondb project

• Host: GitHub
• URL: https://github.com/jegj/protondb-cli
• Owner: jegj
• License: gpl-3.0
• Created: 2022-12-21T00:36:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-11T06:53:17.000Z (over 1 year ago)
• Last Synced: 2025-02-22T19:02:29.087Z (over 1 year ago)
• Topics: cli, nodejs, protondb
• Language: JavaScript
• Homepage:
• Size: 9.86 MB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# protondb-cli

[![CI](https://github.com/jegj/protondb-cli/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/jegj/protondb-cli/actions/workflows/build.yml)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)

[![view on npm](http://img.shields.io/npm/v/protondb-cli.svg)](https://www.npmjs.com/package/protondb-cli)

[![license](http://img.shields.io/npm/l/protondb-cli.svg)](https://www.npmjs.com/package/protondb-cli)

A simple unofficial CLI for [ProtonDB project](https://www.protondb.com/).

Let's face it, if you know about ProtonDB you must love video

games and Linux and what better than an CLI for a Linux fan

to check your games compatibility on Steam.

![protondb-cli.gif](docs/imgs/readme.gif)

## Installation

```sh

npm i protondb-cli -g

```

## Usage

```sh

protondb-cli "Counter strike"

```

### Tiers

Describe the support on Linux with ProtonDB

| Tier      | Description                                                               |

| :-------- | :------                                                                   |

| Platinum  | Runs perfectly out of the box                                             |

| Gold      | Runs perfectly after tweaks                                               |

| Silver    | Runs with minor issues, but generally playable                            |

| Bronze    | Runs, but often crashes or has issues preventing from playing comfortably |

| Borked    | Either won't start or is crucially unplayable                             |

| N/A       | Wihtout Tier. Comunity haven't report this game yet                       |

### Confidence

Describe the support of the community under the tier

## Using Docker

```sh

docker pull jegj/protondb-cli

docker run -it --rm jegj/protondb-cli fifa

```

## Adding command "protondb" to your terminal

By adding the following code to your terminal (for example `~/.zshrc`), you can use it pretty easy.

```sh

protondb() {

    if [ -z "$1" ]; then

        echo "Usage: protondb "

        return 1

    fi

    docker pull jegj/protondb-cli

    docker run -it --rm jegj/protondb-cli "$1"

}

```

You can also use the following command, to add it automatically into the rc file of your current shell (zsh or bash only).

```sh

rc="$HOME/.bashrc"; [ -n "$ZSH_VERSION" ] && rc="$HOME/.zshrc"; grep -q '^protondb()' "$rc" 2>/dev/null && echo "protondb function already exists in $rc – nothing to do." || { printf '\nprotondb() {\n    if [ -z "$1" ]; then\n        echo "Usage: protondb "\n        return 1\n    fi\n    docker pull jegj/protondb-cli\n    docker run -it --rm jegj/protondb-cli "$1"\n}\n' >> "$rc" && echo "protondb function has been installed in $rc"; }

```