doc/README.scorelog

   1
   2 Format description of the scorelog format version 2
   3 ===================================================
   4
   5 Empty lines and lines starting with '#' are comments. Each non-comment
   6 line starts with a command. The parameter are supplied on that line
   7 and are seperated by a space. Strings which may contain whitespaces
   8 are always the last parameter and so extend till the end of line.
   9
  10 The following commands exists:
  11   id <game-id>
  12     <game-id> is a string without whitespaces which is used
  13               to match a scorelog against a savegame.
  14
  15   tag <tag-id> <descr>
  16     add a data-type (tag)
  17       the <tag-id> is used in the 'data' commands
  18       <descr> is a string without whitespaces which
  19               identified this tag
  20
  21   turn <turn> <number> <descr>
  22     adds information about the <turn> turn
  23       <number> can be for example year
  24       <descr> may contain whitespaces
  25
  26   addplayer <turn> <player-id> <name>
  27     adds a player starting at the given turn (inclusive)
  28       <player-id> is a number which can be reused
  29       <name> may contain whitespaces
  30
  31   delplayer <turn> <player-id>
  32     removes a player from the game. The player was
  33       active till the given turn (inclusive)
  34       <player-id> used by the creation
  35
  36   data <turn> <tag-id> <player-id> <value>
  37     give the value of the given tag for the given
  38     player for the given turn.