changeset 961:45497e8a7c90

Bump loc version to 4.0; Update loc format documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 09 Jun 2010 23:44:48 +0000
parents f2fcbf6ad2ef
children 432549cf67a6
files README.loc mkloc.c
diffstat 2 files changed, 29 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/README.loc	Wed Jun 09 21:08:54 2010 +0000
+++ b/README.loc	Wed Jun 09 23:44:48 2010 +0000
@@ -1,9 +1,17 @@
 MapUtils '.loc' file format documentation
 =========================================
+CHANGES FROM v3.x
+-----------------
+
+ * Location name field can now have special flag prefixes on each
+   subfield to indicate original (in-game) area name, etc.
+ * Creator/coder name field can now have special flag prefixes on each
+   subfield to indicate original coder, maintainer or recoder.
+ * Certain new flags were added.
+
+
 CHANGES FROM v2.x
 -----------------
-Following important changes were implemented in transition from
-fileformat v2 to v3:
 
  * Records are no longer line-based, but can span multiple lines.
    A new record can only start after a newline, though.
@@ -17,7 +25,7 @@
 --------------------------
 A properly formatted loc-file MUST start with line:
 
-# MapUtils LOC file (version 3.0)
+# MapUtils LOC file (version 4.0)
 
 Processing software MAY check against the version number to see if they
 are compatible with the format. Any backwards-incompatible changes
@@ -72,6 +80,7 @@
      'F' = Regional Fort
 
    Special flags:
+     '!' = Location is closed.
      '-' = Location is "invisible". Practically means that some operations
            of mkloc utility ignore this marker. In generated maps the marker
            itself MUST be placed, but label MUST NOT be drawn.
@@ -81,13 +90,23 @@
    share the same location identifier. Additional alternative names can
    be specified, separated by pipe character ('|').
 
-   NOTICE: By convention, the 'real' name of the area, shown by BatMUD
-   'whereami' command, should be the LAST one (if there are alternative names).
+   Each subfield (including the first unique identifier), MAY be prefixed
+   with one of the following characters:
+
+     '@' = Original, in-game name of the area. Typically output of 'whereami'
+           command in flower BatMUD.
 
  * [OPT] Creators: Contains comma-separated list of wizard names involved in
    creating or maintaining the area or otherwise related to the location.
    Example: ;Darol,Durand,Dazzt;
 
+   Each subfield (including the first unique identifier), MAY be prefixed
+   with one of the following characters:
+
+     '@' = Original creator/coder of the area.
+     '!' = Recoder or re-implementor.
+     '%' = Maintainer (sometimes analogous to recoder, though).
+
  * [OPT] Timestamp: MAY be left empty, otherwise a timestamp of when the area
    was added in the game. Formatted as 'dd.mm.yyyy', zero-padded.
    Examples: 21.03.2008; 02.12.1996
--- a/mkloc.c	Wed Jun 09 21:08:54 2010 +0000
+++ b/mkloc.c	Wed Jun 09 23:44:48 2010 +0000
@@ -14,7 +14,7 @@
 /* Version string
  */
 #define LOC_MAGIC           "MapUtils LOC file"
-#define LOC_VERSION_MAJOR   (3)
+#define LOC_VERSION_MAJOR   (4)
 #define LOC_VERSION_MINOR   (0)
 
 
@@ -77,9 +77,9 @@
 #define LOC_MAX_FILES       (64)
 
 
-#define NAME_ORIG           (0x00001)   /* Original area name or coder */
-#define NAME_RECODER        (0x00002)   /* Recoder of area */
-#define NAME_MAINTAINER     (0x00004)   /* Maintainer */
+#define NAME_ORIG           (0x00001)   /* '@' Original area name or coder */
+#define NAME_RECODER        (0x00002)   /* '!' Recoder of area */
+#define NAME_MAINTAINER     (0x00004)   /* '%' Maintainer */
 
 
 /* Structures
@@ -1691,7 +1691,7 @@
     th_memset(&worldLoc, 0, sizeof(worldLoc));
 
     /* Initialize */
-    th_init("mkloc", "Manipulate and convert location files and ASCII map data", "1.3", NULL, NULL);
+    th_init("mkloc", "Manipulate and convert location files and ASCII map data", "1.4", NULL, NULL);
     th_verbosityLevel = 0;
     
     /* Parse arguments */