update docs a bit
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
# Silent FH
|
||||
|
||||
In Silent FH, you play as a student trapped overnight in the FH Joanneum. During the night the professors turn into monsters and hunt down the trapped students.
|
||||
In Silent FH, you play as a student trapped overnight in the FH Joanneum. During the night the professors turn into
|
||||
monsters and hunt down the trapped students.
|
||||
Your goal is to survive.
|
||||
|
||||
This project uses uv and PyGame as its main libraries.
|
||||
@@ -9,20 +10,39 @@ To get uv, please see here: https://docs.astral.sh/uv/getting-started/installati
|
||||
|
||||
To sync the dependencies, please run:
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
uv sync
|
||||
source .venv/bin/activate or source .venv/bin/activate.fish
|
||||
uv run main.py
|
||||
```
|
||||
|
||||
Coding Guidelines:
|
||||
## Usage of the game:
|
||||
|
||||
- Use WASD or Arrow Keys to move around
|
||||
- Use E to buy items (if you have enough ECTS)
|
||||
- Survive or die
|
||||
- Coffee heals the door
|
||||
- Beer increases your ETCS generation
|
||||
|
||||
Live long enough and get the highest amount of ETCS you can!
|
||||
|
||||
### Coding Guidelines:
|
||||
|
||||
- Using branches for features, named like so: feat/feature-name
|
||||
- Using pull requests and merging for code review
|
||||
- Using semantic commits for a good overview of the changes, for example:
|
||||
- feat(component): added new component
|
||||
- fix(bug): fixed a bug
|
||||
- docs(readme): updated documentation
|
||||
- chore(ci): automated build and deployment
|
||||
- feat(component): added new component
|
||||
- fix(bug): fixed a bug
|
||||
- docs(readme): updated documentation
|
||||
- chore(ci): automated build and deployment
|
||||
|
||||
Game coded up by Baumgartner Kevin, Kammerhofer Lukas, Berger Lena and Haiden Niklas.
|
||||
|
||||
## Responsibilities
|
||||
|
||||
- Baumgartner Kevin: UI, Startscreen, Endscreen, Highscore Display
|
||||
- Berger Lena: Sound Effects, HUD, ECTS System, Doors, Items (Beer and Coffee)
|
||||
- Kammerhofer Lukas: Tower, Map, Design of the game
|
||||
- Haiden Niklas: Merge Requests, Sprites, Zombies, Game Loop Logic, Docs
|
||||
Reference in New Issue
Block a user