Merge pull request #13 from Bahamada/upstream_merge

Upstream merge

3 files changed, 171 insertions, 1 deletions

diff --git a/doc/changelog.txt b/doc/changelog.txt
index f43a68f12..5a01b6bc4 100644
--- a/doc/changelog.txt
+++ b/doc/changelog.txt
@@ -3,7 +3,12 @@ Minetest-c55 changelog
 This should contain all the major changes.
 For minor stuff, refer to the commit log of the repository.
 
-X:
+2011-06-02:
+- Password crash on windows fixed
+- Optimized server CPU usage a lot
+- Furnaces now work also while players are not near to them
+
+2011-05-29:
 - Optimized smooth lighting
 - A number of small fixes
 - Added clouds and simple skyboxes
@@ -13,6 +18,10 @@ X:
 - Slightly updated map format
 - Player passwords
 - All textures first searched from texture_path
+- Map directory ("map") has been renamed to "world" (just rename it to load an old world)
+- Mouse inversion (invert_mouse)
+- Grass doesn't grow immediately anymore
+- Fence added
 
 2011-04-24:
 - Smooth lighting with simple ambient occlusion
diff --git a/doc/mapformat.txt b/doc/mapformat.txt
new file mode 100644
index 000000000..a0241804e
--- /dev/null
+++ b/doc/mapformat.txt
@@ -0,0 +1,89 @@
+I'll try to quickly document the newest block format in here (might contain
+errors). Refer to the mapgen or minetestmapper script for the directory
+structure and file naming. There are two sector namings possible,
+sector/XXXXZZZZ and sector/XXX/ZZZ.
+
+There also exists files map_meta.txt and chunk_meta, that are used by the
+generator. If they are not found or invalid, the generator will currently
+behave quite strangely.
+
+The MapBlock file format (sectors2/XXX/ZZZ/YYYY):
+-------------------------------------------------
+
+NOTE: Byte order is MSB first.
+
+u8 version
+- map format version number, this one is version 17
+
+u8 flags
+- Flag bitmasks:
+  - 0x01: is_underground: Should be set to 0 if there will be no light
+    obstructions above the block. If/when sunlight of a block is updated and
+	there is no block above it, this value is checked for determining whether
+	sunlight comes from the top.
+  - 0x02: day_night_differs: Whether the lighting of the block is different on
+    day and night. Only blocks that have this bit set are updated when day
+	transforms to night.
+  - 0x04: lighting_expired: If true, lighting is invalid and should be updated.
+    If you can't calculate lighting in your generator properly, you could try
+	setting this 1 to everything and setting the uppermost block in every
+	sector as is_underground=0. I am quite sure it doesn't work properly,
+	though.
+
+zlib-compressed map data:
+- content:
+  u8[4096]: content types
+  u8[4096]: param1 values
+  u8[4096]: param2 values
+
+zlib-compressed node metadata
+- content:
+  u16 version (=1)
+  u16 count of metadata
+  foreach count:
+    u16 position (= p.Z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + p.Y*MAP_BLOCKSIZE + p.X)
+	u16 type_id
+	u16 content_size
+	u8[content_size] misc. stuff contained in the metadata
+
+u16 mapblockobject_count
+- always write as 0.
+- if read != 0, just fail.
+
+foreach mapblockobject_count:
+  - deprecated, should not be used. Length of this data can only be known by
+    properly parsing it. Just hope not to run into any of this.
+
+u8 static object version:
+- currently 0
+
+u16 static_object_count
+
+foreach static_object_count:
+  u8 type (object type-id)
+  s32 pos_x * 1000
+  s32 pos_y * 1000
+  s32 pos_z * 1000
+  u16 data_size
+  u8[data_size] data
+
+u32 timestamp
+- Timestamp when last saved, as seconds from starting the game.
+- 0xffffffff = invalid/unknown timestamp, nothing will be done with the time
+               difference when loaded (recommended)
+
+Node metadata format:
+---------------------
+
+Sign metadata:
+  u16 string_len
+  u8[string_len] string
+
+Furnace metadata:
+  TBD
+
+Chest metadata:
+  TBD
+
+// END
+
diff --git a/doc/protocol.txt b/doc/protocol.txt
new file mode 100644
index 000000000..da2d3394f
--- /dev/null
+++ b/doc/protocol.txt
@@ -0,0 +1,72 @@
+Minetest-c55 protocol (incomplete, early draft):
+Updated 2011-06-18
+
+A custom protocol over UDP.
+Integers are big endian.
+Refer to connection.{h,cpp} for further reference.
+
+Initialization:
+- A dummy reliable packet with peer_id=PEER_ID_INEXISTENT=0 is sent to the server:
+	- Actually this can be sent without the reliable packet header, too, i guess,
+	  but the sequence number in the header allows the sender to re-send the
+	  packet without accidentally getting a double initialization.
+	- Packet content:
+		# Basic header
+		u32 protocol_id = PROTOCOL_ID = 0x4f457403
+		u16 sender_peer_id = PEER_ID_INEXISTENT = 0
+		u8 channel = 0
+		# Reliable packet header
+		u8 type = TYPE_RELIABLE = 3
+		u16 seqnum = SEQNUM_INITIAL = 65500
+		# Original packet header
+		u8 type = TYPE_ORIGINAL = 1
+		# And no actual payload.
+- Server responds with something like this:
+	- Packet content:
+		# Basic header
+		u32 protocol_id = PROTOCOL_ID = 0x4f457403
+		u16 sender_peer_id = PEER_ID_INEXISTENT = 0
+		u8 channel = 0
+		# Reliable packet header
+		u8 type = TYPE_RELIABLE = 3
+		u16 seqnum = SEQNUM_INITIAL = 65500
+		# Control packet header
+		u8 type = TYPE_CONTROL = 0
+		u8 controltype = CONTROLTYPE_SET_PEER_ID = 1
+		u16 peer_id_new = assigned peer id to client (other than 0 or 1)
+- Then the connection can be disconnected by sending:
+	- Packet content:
+		# Basic header
+		u32 protocol_id = PROTOCOL_ID = 0x4f457403
+		u16 sender_peer_id = whatever was gotten in CONTROLTYPE_SET_PEER_ID
+		u8 channel = 0
+		# Control packet header
+		u8 type = TYPE_CONTROL = 0
+		u8 controltype = CONTROLTYPE_DISCO = 2
+
+- Here's a quick untested connect-disconnect done in PHP:
+# host: ip of server (use gethostbyname(hostname) to get from a dns name)
+# port: port of server
+function check_if_minetestserver_up($host, $port)
+{
+	$socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
+	$timeout = array("sec" => 1, "usec" => 0);
+	socket_set_option($socket, SOL_SOCKET, SO_RCVTIMEO, $timeout);
+	$buf = "\x4f\x45\x74\x03\x00\x00\x00\x03\xff\xdc\x01";
+	socket_sendto($socket, $buf, strlen($buf), 0, $host, $port);
+	$buf = socket_read($socket, 1000);
+	if($buf != "")
+	{
+		# We got a reply! read the peer id from it.
+		$peer_id = substr($buf, 9, 2);
+		
+		# Disconnect
+		$buf = "\x4f\x45\x74\x03".$peer_id."\x00\x00\x02";
+		socket_sendto($socket, $buf, strlen($buf), 0, $host, $port);
+		socket_close($socket);
+		
+		return true;
+	}
+	return false;
+}
+