Update README

3 years ago · 2c070332aa
9 changed files with 2066 additions and 4 deletions
--- a/README.md
+++ b/README.md
@ -125,6 +125,28 @@ Yes. This isn't made for any profit, but if you decide you want to share some fo
				@@ -125,6 +125,28 @@ Yes. This isn't made for any profit, but if you decide you want to share some fo

 ## code guide

+The repository structure is following:
+
+```
+assets/          asset sources (textures, sprites, maps, sounds, ...)
+  *.py           scripts for converting assets to C structs/arrays
+media/           media presenting the game (screenshots, logo, ...)
+constants.h      game constants that aren't considered settings
+images.h         images (textures, sprites) from assets folder converted to C
+levels.h         levels from assets folder converted to C
+palette.h        game 256 color palette
+platform_*.png   fronted implementation for various platforms
+raycastlib.h     raycasting library
+settings.h       game settings that users can change (FPS, resolution, ...)
+sounds.h         sounds from assets folder converted to C
+texts.h          game texts
+main.c           main game logic, this file is passed to the compiler
+make.sh          compiling script constaining compiler settings
+HTMLshell.html   HTML shell for emscripten (browser) version
+index.html       game website
+README.md        this readme
+```
+
 TODO

 source files
--- a/assets/levelD.gif
+++ b/assets/levelD.gif
--- a/assets/levelE.gif
+++ b/assets/levelE.gif
--- a/assets/levelZ.gif
+++ b/assets/levelZ.gif
--- a/game.html
+++ b/game.html
@ -0,0 +1 @@
				@@ -0,0 +1 @@
+<!doctypehtml><html><head><meta charset=utf-8><title>game</title></head><body><canvas class=emscripten id=canvas oncontextmenu=event.preventDefault() tabindex=-1></canvas><script>var Module={print:function(n){console.log(n)},printErr:function(n){console.error(n)},canvas:document.getElementById("canvas")}</script><script async src=game.js></script></body></html>
--- a/index.html
+++ b/index.html
@ -159,7 +159,7 @@
				@@ -159,7 +159,7 @@

    <span class="subtitle">the suckless, anticapitalist, public domain game, for everyone</span>

-    <img src="assets/logo_big.png">
+    <img src="media/logo_big.png">

    <span class="wow">THIS IS SPECIAL</span>

--- a/assets/logo_big.png
+++ b/assets/logo_big.png
--- a/raycastlib_old.h
+++ b/raycastlib_old.h
--- a/settings.h
+++ b/settings.h
@ -21,9 +21,10 @@
				@@ -21,9 +21,10 @@
  Target FPS (frames per second). This sets the game logic FPS and will try to
  render at the same rate. If such fast rendering can't be achieved, frames will
  be droped, but the game logic will still be forced to run at this speed, so
-  the game may actually become slowed down if FPS is set too high. Too high FPS
-  can also negatively affect game speeds which are computed as integers and
-  rounding errors can occur soon, so don't set this to extreme values.
+  the game may actually become slowed down if FPS is set too high. Too high or
+  too low FPS can also negatively affect game speeds which are computed as
+  integers and rounding errors can occur soon, so don't set this to extreme
+  values (try to keep from 20 to 100).
 */
 #define SFG_FPS 60
				`@ -0,0 +1 @@` @@ -0,0 +1 @@
				`<!doctypehtml><html><head><meta charset=utf-8><title>game</title></head><body><canvas class=emscripten id=canvas oncontextmenu=event.preventDefault() tabindex=-1></canvas><script>var Module={print:function(n){console.log(n)},printErr:function(n){console.error(n)},canvas:document.getElementById("canvas")}</script><script async src=game.js></script></body></html>`