update docs a bit

This commit is contained in:
Niklas Haiden
2026-05-08 20:11:35 +02:00
parent b002998adb
commit c562985664
+26 -6
View File
@@ -1,6 +1,7 @@
# Silent FH # 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. Your goal is to survive.
This project uses uv and PyGame as its main libraries. 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: To sync the dependencies, please run:
## Usage
``` ```
uv sync uv sync
source .venv/bin/activate or source .venv/bin/activate.fish source .venv/bin/activate or source .venv/bin/activate.fish
uv run main.py 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 branches for features, named like so: feat/feature-name
- Using pull requests and merging for code review - Using pull requests and merging for code review
- Using semantic commits for a good overview of the changes, for example: - Using semantic commits for a good overview of the changes, for example:
- feat(component): added new component - feat(component): added new component
- fix(bug): fixed a bug - fix(bug): fixed a bug
- docs(readme): updated documentation - docs(readme): updated documentation
- chore(ci): automated build and deployment - chore(ci): automated build and deployment
Game coded up by Baumgartner Kevin, Kammerhofer Lukas, Berger Lena and Haiden Niklas. 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