Update README
parent
32666d4e2d
commit
c68eee3bee
22
README.md
22
README.md
|
@ -1,10 +1,22 @@
|
|||
# Zoria
|
||||
An RPG Dungeon Crawler using PyGame
|
||||
Real-time 2.5D RPG Dungeon Crawler using PyGame
|
||||
|
||||
## Usage
|
||||
`python3 zoria.py`
|
||||
|
||||
## Notes
|
||||
* Features currently only include rendering, map generation, movement, and sprite animation
|
||||
* `setup.sh` is for git configuration across multiple machines (don't use it)
|
||||
* `map.json` is not in use. `generator.py` creates maps when loading
|
||||
## Controls
|
||||
| Key | Action |
|
||||
| ------- | --------- |
|
||||
| `WASD` | Movement |
|
||||
| `SPACE` | Attack |
|
||||
| `SHIFT` | Use stair |
|
||||
|
||||
## Premise
|
||||
Each level contains a key and a locked hatch. Collect the key in order to unlock the passage to the next level (`SHIFT` to unlock).
|
||||
Slimes do minimal damage, but more spawn on each level. They can drop health or XP. More XP = more damage dealt per hit. Coins are currently useless.
|
||||
The levels are infinite and persistent. The only limit is your RAM. World resets on death.
|
||||
|
||||
## Known Bugs
|
||||
* Window resizing is mostly broken on Linux. This is a bug in SDL2. Using the maximize button _should_ work most of the time.
|
||||
* Slimes get stuck in corners. Probably due to the raycaster hitting the corner at the start (rounding issue?).
|
||||
* Walls occasionally render improperly. Usually occurs when two rooms are close to each other diagonally.
|
||||
|
|
21
setup.sh
21
setup.sh
|
@ -1,21 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
printf "Username: "
|
||||
read NAME
|
||||
|
||||
printf "Email: "
|
||||
read EMAIL
|
||||
|
||||
echo "Configuring git..."
|
||||
|
||||
git config user.name $NAME
|
||||
git config user.email $EMAIL
|
||||
|
||||
git config credential.username $NAME
|
||||
git config credential.email $EMAIL
|
||||
|
||||
echo "Installing pylint..."
|
||||
pip3 install pylint
|
||||
|
||||
echo "Installing pygame..."
|
||||
pip3 install pygame
|
Loading…
Reference in New Issue