From: Lukas Krickl <lukas@krickl.dev>
Date: Fri, 25 Jul 2025 07:40:52 +0000 (+0200)
Subject: mapgen: updated mapgen docs
X-Git-Url: https://git.krickl.dev/?a=commitdiff_plain;h=d8d27a9d04ca7c8b463f8c545bbb3688ef1111ce;p=gbrg%2F.git

mapgen: updated mapgen docs
---

diff --git a/src/mapgen.s b/src/mapgen.s
index bac5fc1..16cd4c7 100644
--- a/src/mapgen.s
+++ b/src/mapgen.s
@@ -2,13 +2,13 @@
 
   ; places a rectangular room
   ; into the currently loaded map
-  ; 1) searches the map for a suitable location
-  ; 2) draws the room 
-  ; 3) places doors
-  ; 4) places between 1-3 actors from a valid actor list
-  ;    actor placement may fail if the actor table is full
-  ; If the tile id is not 0 this rotuine will consider the tile invalid
-  ; and will never write to it
+  ; 1) places room patterns in top left, top right, bottom left, bottom right
+  ;    patterns are chosen from a list of valid patterns which is determined by
+  ;    the current floor
+  ; 6) place larger room patterns that may overwrite existing patterns
+  ; 5) run floor-based post processing (look up routine from table)
+  ; 7) palce actors on floor tiles based on a table of actors 
+  ;    chosen based on the floor
   ; inputs:
   ;   hl: writable decompressed tile array (e.g [map]) 
   ;       of size MAP_H * MAP_W