Add readme

Avokadoen · Aug 11, 2024 · 773db2d · 773db2d
1 parent 868cb2c
commit 773db2d
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,53 @@
+# Gamejam 09_08_24
+
+This was my, @Eivindaj and @JayJayDev's gamejam from 09.08.24-11.08.24
+
+We wanted to make something inspired by binding of isaac. The game is build with the [zig programming language (v0.13.0)](https://ziglang.org/),
+[raylib](https://www.raylib.com/) using [raylib-zig](https://github.com/Not-Nik/raylib-zig) as our bindings for zig.
+
+It also uses my ecs library [ecez](https://github.com/Avokadoen/ecez) for the game logic. 
+
+# How to run
+
+You must have git and zig 0.13.0 to run this project.
+
+```
+git clone https://github.com/Avokadoen/gamejam_09_08_24
+cd gamejam_09_08_24
+zig build run
+```
+
+# Game rules
+
+## Input 
+
+wasd to move arrows to shoot
+tab to open a inventory that does nothing
+
+## Inventory and spells 
+
+wizard is equipped with the only staff in the game which is slotted with two spells where on of the spells is using a piering and added damage modifier (this was supposed to be customizable in the inventory :') ).
+
+## Win condition 
+
+Killing 100 farmers will spawn the farmers wife. I don't think she is happy you have already killed 100 of her husbands!
+Killing the farmers wife will give you the victory screen, good job, you monster!
+
+# Screenshots
+
+## Main Menu
+![main_meny](screenshots/main_menu.png)
+
+## Ingame
+![ingame1](screenshots/ingame.png)
+![ingame2](screenshots/ingame2.png)
+
+## Victory 
+
+![victory](screenshots/victory.png)
+
+# AI assets
+
+All assets listed here are made by AI, and not us. 
+
+ - resources\music\Gameplay_Loop.wav
diff --git a/screenshots/ingame.png b/screenshots/ingame.png
diff --git a/screenshots/ingame2.png b/screenshots/ingame2.png
diff --git a/screenshots/main_menu.png b/screenshots/main_menu.png
diff --git a/screenshots/victory.png b/screenshots/victory.png