From 6de46b1197d85be8f769c0e9518201f05f31a2db Mon Sep 17 00:00:00 2001
From: Alexandre <cpge.aboujaib@gmail.com>
Date: Sat, 22 Feb 2025 12:05:23 +0100
Subject: [PATCH] updating readme

---
 README.md | 42 +++++++++++++++++++++++++-----------------
 1 file changed, 25 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 1f4f738..f1b3142 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,15 @@
+# --| Syntax for level files |--
 
+1) **General rule**
+each file must be named "room_k" where k is a positive integer
+if "room_k" exists then all "room_u" where 0 <= u < k exists
+
+2) **Data structure**
+below is a detailled list for all block types ;
+each block type (Blocks, Teleporters, Entities) must have the corresponding word directly above it
+not all three keywords have to be written
+
+*Data-specific structure :*
 blocks:
     [x, y, z, w, h, d, rhz, rvt, r, g, b]
 
@@ -7,36 +18,33 @@ teleporters:
 
 entities: 
     [x, y, z, w, h, d, rhz, rvt, r, g, b, hp, damage, entityType ..]
-    // Entity types are : 
-    // 0 (coin) -> damage equals the coin's value
-    // 1 (still explosive)
-    // 2 (seeking explosive)
-    // 3 (shooting still explosive)
-    // if entityType = 4 (moving platform)
-        [.. amplitude_x, amplitude_y, amplitude_z, mult, divd, phase] with
+    *Entity types are :*
+    -> **0 (coin)** -> damage equals the coin's value
+    -> **1 (non-moving explosive)**
+    -> **2 (seeking explosive)**
+    -> **3 (shooting non-moving explosive)**
+    -> **4 (moving platform)**
+        [.. amplitude_x, amplitude_y, amplitude_z, mult, divd, phase] with *<- extra arguments at the end of []*
             amplitude_{x,y,z} = double[>= 0.0]
             {mult,divd} = int
             {phase} = int[0, 360]
 
-    // else if entityType = 5 (linear moving platform)
+    -> **5 (linear moving platform)**
         [.. amplitude_x, amplitude_y, amplitude_z, speed_x, speed_y, speed_z] with
-        amplitude_{x,y,z} = double[>= 0.0]
-        speed_{x,y,z} = double
+            amplitude_{x,y,z} = double[>= 0.0]
+            speed_{x,y,z} = double
 
-    // else if entityType = 6 (text box)
+    -> **6 (text box)**
         [.. text, tred, tgreen, tblue] with
             text = {char*}
 
-    // else if entityType = 7 (warp text box)
+    -> **7 (warp text box)**
         [.. dest_folder, room_count, text, tred, tgreen, tblue] with
             {dest_folder,text} = {char*} (length <= 50)
             {r,g,b} = int[0-256]
 
 
-    // else if entityType = 8 (lock box)
+    -> **8 (lock box)**
         [.. cost, doPay, tred, tgreen, tblue] with
             cost = int[> 0] (0 breaks)
-            doPay = {0, 1} (bool)
-
-    else 
-        [..]
\ No newline at end of file
+            doPay = {0, 1} (bool)
\ No newline at end of file