https://github.com/kfields/badwing

Skateboarder/Platformer/Lepidopterist Game using Arcade & Pymunk
https://github.com/kfields/badwing

Last synced: 3 days ago
JSON representation

Skateboarder/Platformer/Lepidopterist Game using Arcade & Pymunk

• Host: GitHub
• URL: https://github.com/kfields/badwing
• Owner: kfields
• License: mit
• Created: 2020-03-23T02:47:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-04T01:22:07.000Z (about 1 year ago)
• Last Synced: 2024-10-08T12:07:10.273Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 181 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BadWing :butterfly:

Skateboarder/Platformer/Lepidopterist Game using Arcade & Pymunk

## Quick Links

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

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

## Installation

### From PyPI

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

```bash

pip install badwing

```

#### Recommended - pipX

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

```bash

pipx install badwing

```

#### And then run it!

```bash

badwing run

```

### From GitHub

Clone the repository

```bash

git clone https://github.com/kfields/badwing.git

```

Navigate to the new directory which contains the repository

```bash

cd badwing

```

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 badwing

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