From 125a5b85f8a252a162d4ed7539cf3964b2101c48 Mon Sep 17 00:00:00 2001
From: Aki <nthirtyone@gmail.com>
Date: Sun, 31 Jul 2016 21:59:07 +0200
Subject: Map editing and general map update

---
 maps/readme.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 75 insertions(+), 13 deletions(-)

(limited to 'maps/readme.md')

diff --git a/maps/readme.md b/maps/readme.md
index 5d0a8ee..dc139ad 100644
--- a/maps/readme.md
+++ b/maps/readme.md
@@ -1,20 +1,82 @@
 # Mapmaking
-*Hugs Emo*.
-### Center
-It is the center of the map. Camera will use it for tracking and together with **map size** they will cause deaths to players (IRL).
+*Hugs Emo*
 
-### Size
-This is used for camera and checking if naut should die. Camera tracks nauts that are in rectangle with *width* x *height* size with its center in **map center**. 
+### Name (string)
+Name of the map. Should be same as the filename. *I think*.
+```lua
+name = "default"
+```
 
-Nauts will die if they are outside of rectangle with *width&sdot;2* x *height&sdot;2* size also with its center in the **map center**.
+### Center (int)
+Coordinates of center of the map. Camera zone and death zone are placed relative to it.
+```lua
+center_x = 0,
+center_y = 0
+```
 
-### Colors
-In RGBA format.
+### Size (int)
+Width and height of playground. Camera zone and death zone sizes are calculated based on map size.
+```lua
+width  = 360,
+height = 240
+```
 
-### Respawns
-Global coordinates to each respawn point.
+### Respawns (table, int)
+Table of possible respawn points. Players will randomly spawn on one of these points.
+```lua
+respawns = {
+	{x = -15, y = -80},
+	{x =  -5, y = -80},
+	{x =   5, y = -80},
+	{x =  15, y = -80}
+}
+```
 
-### Platforms
-This image should explain most parts of creating platforms:
+### Clouds (bool)
+Presence of clouds. Clouds will spawn if set to **true**.
+```lua
+clouds = true
+```
 
-![alt](https://raw.githubusercontent.com/nthirtyone/not-nautz/master/maps/platform.png)
+### Background (string)
+Path to background image in the game structure. It will be used as fixed background.
+```lua
+background = "assets/background-default.png"
+```
+
+### Platforms (table, int, string)
+Platforms on which player can stand. They will be placed on given coordinates with given sprite and shape.
+Shape are points placed relatively to platform's coordinates. Shape points are connected in given order. On top of that last point is connected with first one.
+```lua
+platforms = {
+	{
+		x = -91,
+		y = 0,
+		shape = {0,1, 181,1, 181,10, 96,76, 86,76, 0,10},
+		sprite = "assets/platform_big.png"
+	},
+	{
+		x = 114,
+		y = 50,
+		shape = {0,1, 52,1, 52,30, 0,30},
+		sprite = "assets/platform_small.png"
+	}
+}
+```
+
+### Decoration (table, int, string)
+Decorations are objects in the background which are not fixed but move alongside with foreground objects (platforms, players, clouds). They do not have physical body.
+```lua
+decorations = {
+	{
+		x = -80,
+		y = 10,
+		sprite = "assets/decoration_big.png"
+	},
+	{
+		x = 50,
+		y = 50,
+		sprite = "assets/decoration_small.png"
+	}
+}
+```
\ No newline at end of file
-- 
cgit v1.1