waylon/creeper-adventure
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Waylon Walker 2023-01-04 09:40:01 -06:00 • committed by GitHub
parent 93d52d87e1
commit 69db57c10e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,5 +1,10 @@
<img src='https://github.com/WaylonWalker/creeper-adventure/blob/main/creeper_adventure/assets/stev/idle/0.png' align="right">
<img src='https://github.com/WaylonWalker/creeper-adventure/blob/main/creeper_adventure/assets/bee/idle/1.png' align="right">
# creeper-adventure
Creeper adventure is a top down 2d adventure game that I am building with my son using pygame.
[![PyPI - Version](https://img.shields.io/pypi/v/creeper-adventure.svg)](https://pypi.org/project/creeper-adventure)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/creeper-adventure.svg)](https://pypi.org/project/creeper-adventure)
@ -16,6 +21,31 @@
pip install creeper-adventure
```
## Running
```console
# run the game
creeper-adventure
# run in debug mode
creeper-adventure --debug
# see all options available
creeper-adventure --help
```
## running with pipx
`creeper-adventure` can also run using pipx if you have pipx installed.
```console
pipx run creeper-adventure
```
## Download an exe
pre-built binaries are available from the website [creeper-adventure](https://creeper-adventure.waylonwalker.com).
## License
`creeper-adventure` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.