From 8aa8aee971484e49fe299c0c1d4afc54c81a1aa4 Mon Sep 17 00:00:00 2001 From: alistair Date: Fri, 28 Jan 2022 17:26:27 +1000 Subject: [PATCH] readme --- README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 30ddd52..6fc462f 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,39 @@ # A computer game -[Developemnt Blog](https://alistairmichael.com/projects/game/) +[Developement Blog](https://alistairmichael.com/projects/game/) ![image](https://alistairmichael.com/media/game3.png) -# Prebuilt Binary +This is a simple game where you play as a bouncy square rock that has a grappling hook. It can use the grappling hook to swing to the end of the cave. There is no reward for doing so, but there is a timer. + +### Description and Features + +- Entirely written in C using only the SDL2 graphics and audio libraries. +- Procedurally generated cave environment using a random walk and procedurally + generated colour palettes. +- Cute synthesized sound effects using integer overflow a la [bytebeat](https://arxiv.org/pdf/1112.1368.pdf). +- 2D Graphics using the SDL2 API, no assets are used aside from the font. +- Point mass elastic physics with elastic collisions. + - Separating Axis Theorem collision test for convex polygons. + - Framerate independent physics uses a fixed timestep and completes as many + steps as neccessary to catch up to each frame. + - Physics runs in a separate thread and state is managed using shared memory and + locks. + - Player physics interactions use forces applied to physics bodies which are + integrated into impulses and positions. +- Grappling hook. + +# Installation + +## Prebuilt Binary See the releases tab. On Linux and other Unix-Like operating systems you will need to install the SDL2 package from your package maintainer. -### Fedora - ```sh +# on Fedora sudo dnf install SDL2 ```