X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fworld_format.txt;h=976d14fd5f0e8ec16b473220dcef614968c29a50;hb=fd3afbced5410639325e730d5710b8b5039b320e;hp=105fbb63ee7b4c060808c3c1362d4b419502b08e;hpb=8acccf4c584b31ab08dc6ba0b95cb223c8ab4dad;p=minetest.git

diff --git a/doc/world_format.txt b/doc/world_format.txt
index 105fbb63e..976d14fd5 100644
--- a/doc/world_format.txt
+++ b/doc/world_format.txt
@@ -1,12 +1,13 @@
 =============================
-Minetest World Format 22...25
+Minetest World Format 22...27
 =============================
 
 This applies to a world format carrying the block serialization version
-22...25, used at least in
+22...27, used at least in
 - 0.4.dev-20120322 ... 0.4.dev-20120606 (22...23)
 - 0.4.0 (23)
 - 24 was never released as stable and existed for ~2 days
+- 27 was added in 0.4.15-dev
 
 The block serialization version does not fully specify every aspect of this
 format; if compliance with this format is to be checked, it needs to be
@@ -47,8 +48,9 @@ in the base64 encoding.
 
 Format (since 0.4.13) of password hash is #1#<salt>#<verifier>, with the
 parts inside <> encoded in the base64 encoding.
-<verifier> is an RFC 5054 compatible SRP-2048-SHA1 verifier
-of the given salt, password, and the player's name lowercased.
+<verifier> is an RFC 2945 compatible SRP verifier,
+of the given salt, password, and the player's name lowercased,
+using the 2048-bit group specified in RFC 5054 and the SHA-256 hash function.
 
 Example lines:
 - Player "celeron55", no password, privileges "interact" and "shout":
@@ -250,7 +252,7 @@ NOTE: Zlib data is in such a format that Python's zlib at least can
       directly decompress.
 
 u8 version
-- map format version number, this one is version 22
+- map format version number, see serialisation.h for the latest number
 
 u8 flags
 - Flag bitmasks:
@@ -261,15 +263,36 @@ u8 flags
   - 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.
+  - 0x04: lighting_expired: Not used in version 27 and above. 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.
   - 0x08: generated: True if the block has been generated. If false, block
     is mostly filled with CONTENT_IGNORE and is likely to contain eg. parts
     of trees of neighboring blocks.
 
+u16 lighting_complete
+- Added in version 27.
+- This contains 12 flags, each of them corresponds to a direction.
+- Indicates if the light is correct at the sides of a map block.
+  Lighting may not be correct if the light changed, but a neighbor
+  block was not loaded at that time.
+  If these flags are false, Minetest will automatically recompute light
+  when both this block and its required neighbor are loaded.
+- The bit order is:
+  nothing,  nothing,  nothing,  nothing,
+  night X-, night Y-, night Z-, night Z+, night Y+, night X+,
+  day X-,   day Y-,   day Z-,   day Z+,   day Y+,   day X+.
+  Where 'day' is for the day light bank, 'night' is for the night
+  light bank.
+  The 'nothing' bits should be always set, as they will be used
+  to indicate if direct sunlight spreading is finished.
+- Example: if the block at (0, 0, 0) has
+  lighting_complete = 0b1111111111111110,
+  then Minetest will correct lighting in the day light bank when
+  the block at (1, 0, 0) is also loaded.
+
 u8 content_width
 - Number of bytes in the content (param0) fields of nodes
 if map format version <= 23:
@@ -296,13 +319,26 @@ if content_width == 2:
 
 zlib-compressed node metadata list
 - content:
+if map format version <= 22:
   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] (content of metadata)
+    u8[content_size] content of metadata. Format depends on type_id, see below.
+if map format version >= 23:
+  u8 version (=1) -- Note the type is u8, while for map format version <= 22 it's u16
+  u16 count of metadata
+  foreach count:
+    u16 position (p.Z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + p.Y*MAP_BLOCKSIZE + p.X)
+    u32 num_vars
+    foreach num_vars:
+      u16 key_len
+      u8[key_len] key
+      u32 val_len
+      u8[val_len] value
+    serialized inventory
 
 - Node timers
 if map format version == 23:
@@ -378,8 +414,9 @@ The name-id-mapping
 --------------------
 The mapping maps node content ids to node names.
 
-Node metadata format
----------------------
+Node metadata format for map format versions <= 22
+---------------------------------------------------
+The node metadata are serialized depending on the type_id field.
 
 1: Generic metadata
   serialized inventory