summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLeo Tenenbaum <pommicket@gmail.com>2020-12-13 14:40:40 -0500
committerLeo Tenenbaum <pommicket@gmail.com>2020-12-13 14:40:40 -0500
commit9a3044749ed05ff657e274b0de85b9d25aa5f04a (patch)
treedac650a02e625fde464c8fc333b7e61b67401692 /README.md
parent2146ec5f34e020e4b86e604fdf4859fc55d8f199 (diff)
finishing touches for windows version
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 43 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9bfac79..9c206ba 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,35 @@
Computer-generated catapults.
-Somewhat inspired by [boxcar2d](https://boxcar2d.com).
+Created for [PROCJAM 2020](https://itch.io/jam/procjam).
+
+Somewhat inspired by [boxcar2d](http://boxcar2d.com).
+
+Press F11 to toggle fullscreen and Ctrl+Q (or just close the window) to quit.
+
+## How it works
+
+The algorithm begins by generating 110 random catapults, then throwing out all but the top 10 (in terms of
+the distance the ball traveled).
+Then, for each generation, 100 new catapults are generated from the top 10 from the last generation.
+Each new catapult is a copy of one of the old ones, with a chance of having some "mutations".
+These mutations slightly modify the setup, by changing the positions, sizes, etc. of platforms.
+Each generation has catapults with different mutations rates (20 with a 5% mutation rate per platform, 20 with a 10%
+mutation rate, 20 with a 20% mutation rate, 20 with a 30% mutation rate, and 20 completely random new setups).
## Editor controls
-@TODO
+Left mouse - build / edit platform
+Right mouse - delete platform
+W/A/S/D - pan
+Up/Down - change platform size
+Left/Right - change platform angle
+R - toggle rotating platform
+Q - decrease rotation speed
+E - increase rotation speed
+M - toggle moving platform
+Z - decrease move speed
+X - increase move speed
+space - simulate catapult
# Compiling it yourself
You will need SDL2 and Box2D.
@@ -31,7 +56,7 @@ Now, just run `make release`, and you will get the executable `boxcatapult2d`.
## Windows
First, you will need MSVC and `vcvarsall.bat` in your PATH.
-Then, download SDL2 (Visual C++ 32/64-bit): https://www.libsdl.org/download-2.0.php
+Then, download <a href="https://www.libsdl.org/download-2.0.php" target="_blank">SDL2 (Visual C++ 32/64-bit)</a>.
Copy the contents of the folder `SDL2-something\lib\x64` into the same directory as Boxcatapult2D,
and copy the folder `SDL2-something\include` there too, renaming it to `SDL2`.
@@ -49,3 +74,18 @@ copy bin\Release\box2d.lib ..\..
```
Now, you should be able to run `make.bat release` and you will get `boxcatapult2d.exe`.
+
+## Report a bug
+
+If you find a bug, you can report it to pommicket at gmail.com if you'd like.
+
+## Credits
+Box2D: A physics library
+See: https://box2d.org
+
+Roboto font (assets/font.ttf):
+Courtesy of Google Fonts.
+Apache 2.0 license (see: assets/apache-2.0.txt)
+
+STB truetype (lib/stb\_truetype.h):
+See: https://github.com/nothings/stb