(#427) Fix svg2rects failure on newlines in labels

[nothing.git] / README.md

diff --git a/README.md b/README.md
index 2c359f160e4eec54ac0e2d7eeb2a79c9561abd51..c7a4f30dd1e3c94f84058281eb24eb988f148d7b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ $ mkdir build
 $ cd build/
 $ cmake ..
 $ make
-$ ./nothing <level-file>
+$ ./nothing ../levels/level-01.txt
 $ ./nothing_test
 ```
 
@@ -39,10 +39,32 @@ All of the levels reside in the [./levels/] folder. Use
 
 1. `$ inkscape ./levels/level.svg &`
 2. `$ ./build/nothing ./levels/level.txt &`
-3. `$ make watch`
-4. Edit Level in Inkscape and Save
-5. Switch to the Game and reload level by pressing Q
-6. Go to 1
+3. `$ cd ./levels/`
+4. `$ make watch`
+5. Edit Level in Inkscape and Save
+6. Switch to the Game and reload level by pressing Q
+7. Go to 5
+
+### Objects Reference
+
+#### SVG rect node
+
+| Regex of id  | Description                                                                                                       |
+|--------------|-------------------------------------------------------------------------------------------------------------------|
+| `player`     | Defines the **position** of the Player. **Size is ignored**.                                                      |
+| `rect.*`     | Defines the **size** and **position** of an impenetrable platform block                                           |
+| `box.*`      | Defines the **size** and **position** of a rigid box that obeys the physics of the game                           |
+| `region(.*)` | Defines the **size** and **position** of a region that hides the Goals. `\1` defines the id of the Goal to hide.  |
+| `goal(.*)`   | Defines the **position** of the goal. **Size is ignored**. `\1` defines the id of the region that hides the goal. |
+| `lava.*`     | Defines the **position** and **size** of a lava block.                                                            |
+| `background` | Defines the **color** of the background. **Position and size are ignored**.                                       |
+| `backrect.*` | Defines the **size** and **position** of a solid block in the background.                                         |
+
+#### SVG text node
+
+| Regex of id | Description                                                                |
+|-------------|----------------------------------------------------------------------------|
+| `label.*`   | Defines **position** and **text** of a in-game label. **Size is ignored**. |
 
 ## Build on Windows