https://github.com/rr-/pq-cli

Progress Quest: the CLI edition
https://github.com/rr-/pq-cli

console-game game python

Last synced: 3 months ago
JSON representation

Progress Quest: the CLI edition

• Host: GitHub
• URL: https://github.com/rr-/pq-cli
• Owner: rr-
• License: mit
• Created: 2018-11-05T22:56:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-05T09:01:43.000Z (9 months ago)
• Last Synced: 2024-03-17T08:14:01.223Z (3 months ago)
• Topics: console-game, game, python
• Language: Python
• Homepage:
• Size: 857 KB
• Stars: 116
• Watchers: 10
• Forks: 19
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• my-awesome-github-stars - rr-/pq-cli - Progress Quest: the CLI edition (Python)

README

        


  



Relive the great adventure… this time in the terminal realm!

- Progress Quest site:  http://progressquest.com/

- Online version:       http://progressquest.com/play/

- Original version:     https://bitbucket.org/grumdrig/pq

## Features

- Faithful port of the game logic

- Saves (with backups) to `$XDG_CONFIG_HOME/pqcli/save.dat`

- Terminal interface that comes in 2 flavors:

    - Rich and colorful (`--curses`, default)

    - Minimal, suitable for raw grind (`--basic`)

- Ideal to run on your server

## How it looks like

Curses interface:

![Screenshot](screen-curses-logo.png)

![Screenshot](screen-curses.png)

Basic interface:

![Screenshot](screen-basic.png)

## How to install

If you have Python 3.7, just run `pip install --user pqcli` and you're good to go!

Then type `pqcli` to run the game.

In case if you want to use the git version, the process is just a bit more complex:

```console

$ git clone https://github.com/rr-/pq-cli.git

$ cd pq-cli

$ pip install --user .

```

## Contributing

```sh

# Clone the repository:

git clone https://github.com/rr-/pqcli.git

cd pqcli

# Install to a local venv:

poetry install

# Install pre-commit hooks:

poetry run pre-commit install

# Enter the venv:

poetry shell

```

This project uses [poetry](https://python-poetry.org/) for packaging.

Install instructions are available at [poetry#installation](https://python-poetry.org/docs/#installation).

## Troubleshooting

### `_curses.error: init_pair() returned ERR`

If running on Linux and you get the error `_curses.error: init_pair() returned ERR`,

try making sure that your `$TERM` variable is set to a value which supports

256 colors, such as via the following:

    TERM=xterm-256color pqcli