https://github.com/kfields/cave-mage

Last synced: 11 days ago
JSON representation

README

# BadWing :butterfly:

Skateboarder/Platformer/Lepidopterist Game using Arcade & Pymunk

## Quick Links

:notebook: [Documentation](https://cave_mage.readthedocs.io/en/latest/)

:package: [Package](https://pypi.org/project/cave_mage/)

## Installation

### From PyPI

#### TLDR - do this at your own risk

```bash
pip install cave_mage
```

#### Recommended - pipX

If you don't already have it installed go to https://pypi.org/project/pipx/ for instructions
```bash
pipx install cave_mage
```

#### And then run it!
```bash
cave_mage run
```

### From GitHub

Clone the repository
```bash
git clone https://github.com/kfields/cave_mage.git
```

Navigate to the new directory which contains the repository
```bash
cd cave_mage
```

Create a Python 3 virtual environment called `env`
```bash
python3 -m venv env
```

Activate the environment
```bash
source env/bin/activate
```

Install required packages
```bash
pip install -r requirements.txt
```

## Usage

Activate the virtual environment, if not already active
```bash
cd cave_mage
source env/bin/activate
```

Run the game
```bash
python run_game.py
```

## Controls

### Movement

WASD + cursor keys
Press down to mount/dismount
Press up to do an Ollie! :)

### Pause/Menu

Escape key