Message Formats

• Layers
• Datagram Layer - Dgram(DATA)
• Telegram Layer - Tele(COT,ID,IOB,DATA)
• Browse Layer - Browse(TYPE,SERIAL)
• Data blocks
• empty
• config
• port
• hoststate
• team
• chat
• seed
• result
• times
• frames
• newgame
• gamecfg
• gameid
• Config databases
• game config
• player config
• level config

Layers

Datagram Layer - Dgram(DATA)

     START    - unsigned char, currently \0x68
     LENGTH   - unsigned char, length of DATA = \N
     DATA     - n bytes, given data block
     END      - unsigned char, currently \0x16

Telegram Layer - Tele(COT,ID,IOB,DATA)

     START    - unsigned char, currently \0x68
     LENGTH   - unsigned char, length of DATA = \N
     COT      - unsigned char, cause of transmission
     ID       - unsigned char, id of transmission
     IOB      - unsigned char, information object
     DATA     - n bytes, given data block
     END      - unsigned char, currently \0x16

/* cause of transmission */
typedef enum {
  XBT_COT_Activate,         /* server demands activation */
  XBT_COT_Spontaneous,      /* client message */
  XBT_COT_SendData,         /* send data to client */
  XBT_COT_RequestData,      /* request data from client */
  XBT_COT_DataNotAvailable, /* client does not have data */
  XBT_COT_DataAvailable,    /* client has data */
  /* --- */
  NUM_XBT_COT
} XBTeleCOT;

/* telegram object id */
typedef enum {
  XBT_ID_GameConfig,        /* game data */
  XBT_ID_PlayerConfig,      /* player data */
  XBT_ID_RequestDisconnect, /* host wants disconnect */
  XBT_ID_HostDisconnected,  /* message host has disconnected */
  XBT_ID_StartGame,         /* server starts the game */
  XBT_ID_RandomSeed,        /* seed for random numer generator */
  XBT_ID_LevelConfig,       /* level data */
  XBT_ID_DgramPort,         /* port for datagram connection */
  XBT_ID_Sync,              /* synchronisation between client and server */
  XBT_ID_Async,             /* client and server asynced */
  XBT_ID_HostIsIn,          /* host is in game */
  XBT_ID_HostIsOut,         /* host is out of game */
  XBT_ID_TeamChange,        /* Team Change */
  XBT_ID_WinnerTeam,        /* Client sends winner team for level */
  XBT_ID_GameStat,          /* Host sends game statistics */
  XBT_ID_PID,               /* Central sends PID */
  XBT_ID_Chat,              /* Server/Client sends chat line */
  /* --- */
  NUM_XBT_ID
} XBTeleID;

Browse Layer - Browse(TYPE,SERIAL)

     MAGIC    - char[], currently "XBLAST" (what else? ;)
     PROTO    - unsigned char, protocol version, currently "\x01"
     TYPE     - unsigned char, message type
     SERIAL   - unsigned char, serial of transmission
     DATA     - n bytes, given data block

typedef enum {
  XBBT_None,  /* invalid data */
  XBBT_Query, /* query for games */
  XBBT_Reply, /* direct reply from game server */
  XBBT_NewGame, /* XBCC inform central of new game */
  XBBT_NewGameOK /* XBCC inform central of new game */
} XBBrowseTeleType;

Data blocks

empty

config

port

hoststate

/* client state */
typedef enum {
  XBHS_None,
  XBHS_Wait,   /* waiting for client to send player data */
  XBHS_In,     /* client is in the game */
  XBHS_Out,    /* client is out of the game */
  XBHS_Server, /* host is server */
  XBHS_Ready,  /* host is ready to start */
  /*---*/
  NUM_XBHS
} XBHostState;

team

/* team state */
typedef enum {
  XBTS_None,
  XBTS_Red,   /* unknown if this is good */
  XBTS_Green,
  XBTS_Blue,
  /*---*/
  NUM_XBTS
} XBTeamState;

chat

   ORIGIN   - who sent, higher 4bits are host, lower 4bits are player
   TARGET   - where to send, higher 4bits are host, lower 4bits are player
   DATA     - null terminated string, the message

seed

result

   N        - int (4 bytes), determines number of players and result type
   SCORE    - int[2] (8 bytes), pid of player and score
   ...
   SCORE    - int[2] (8 bytes), pid of player and score

times

   GAMETIME - unsigned short 0xFFFF
   PING     - unsigned short (2 bytes), client ping time
   ...
   PING     - unsigned short (2 bytes), client ping time

frames

   GAMETIME - unsigned short (2 bytes), current game time
   ACTION   - unsigned char (1 byte), player action
   ...
   ACTION   - unsigned char (1 byte), player action

newgame

  PORT    - unsigned short (2 bytes), little-endian port number
  VERSION - unsigned char[3], major/minor/patch version of server
  GAME    - char[48], game name string, null terminated
  ID      - int (4 bytes), little-endian game id
  PAR     - unsigned char[3], numLives/numWins/frameRate

gamecfg

  PORT    - unsigned short (2 bytes), little-endian port number
  VERSION - unsigned char[3], major/minor/patch version of server
  GAME    - char[48], game name string, null terminated
  HOST    - char[32], host ip string, null terminated
  ID      - int (4 bytes), little-endian game id
  PAR     - unsigned char[3], numLives/numWins/frameRate

gameid

Config databases

game config

# GameSetup
• atomLives = (int) : number of lives for each player
• atomRecLives = (int) : number of recommended lives
• atomIfRecLives = (bool) : use recommended lives
• atomWins = (int) : number of needed wins
• atomFrameRate = (int) : frameRate for game
• atomAllLevels = (bool) : choose from all levels
• atomRandomLevels = (bool) : choose levels randomly
• atomRandomPlayers = (bool) : random player positions
• atomRecordDemo = (bool) : record demo
• atomRatedGame = (bool) : communicate results to central
• atomInfoTime = (int) : display time for level info
• atomLevelOrder = (int) : order mode for levels
• atomBot = (bool) : use bot in game
• atomBeep = (bool) : beep when clients connect
• atomMusic = (bool) : play music during game
• atomTeamMode = (string) : team mode, only if non-NULL
# GamePlayers
• atomNumPlayers = (int) : number of local players
• atomArrayPlayer0[] = (string) : player name
• atomArrayControl0[] = (int) : control type
• atomArrayHost0[] = (int) : host type
• atomArrayTeam0[] = (int) : team
# GameHost
• atomHost = (string) : ip string of host
• atomPort = (int) : port of host
• atomFixedUdpPort = (bool) : use fixed udp ports
• atomBrowseLan = (bool) : visible in LAN
• atomAllowNat = (bool) : allow NAT on clients
• atomCentral = (bool) : visible in central
• atomGame = (string) : game name, only if non-NULL
# GameVersion
• atomVersionMajor = (int) : major version of host
• atomVersionMinor = (int) : minor version of host
• atomVersionPatch = (int) : patch version of host

player config

# PlayerGraphics
• atomShape = (atom) : shape of player
• atomHelmet = (color) : helmet color
• atomFace = (color) : face color
• atomBody = (color) : body color
• atomArmsLegs = (color) : arms/legs color
• atomHandsFeet = (color) : hands/feet color
• atomBackpack = (color) : backpack color
# PlayerMessages
• atomMsgWinLevel = (string) : only if non-NULL
• atomMsgWinGame = (string) : only if non-NULL
• atomMsgLoseLife = (string) : only if non-NULL
• atomMsgLoseLevel = (string) : only if non-NULL
• atomMsgGloat = (string) : only if non-NULL
• atomMsgLaola = (string) : only if non-NULL
• atomMsgLoser = (string) : only if non-NULL
• atomMsgWelcome = (string) : only if non-NULL
# PlayerMisc
• atomUseStopKey = (bool) : use stop key
• atomTurnStepKeyboard = (int) : keyboard config
• atomTurnStepJoystick = (int) : joystick config
# PlayerId
• atomPass = (int) : player password for central
• atomPID = (int) : player pid at central
# PlayerName
• atomName = (string) : player name

level config

• atomInfo - 0 : mode string and level info
• atomPlayer - 1 : player positions
• atomShrink - 2 : shrink type
• atomScrambleDraw - 3 : scrambler draw
• atomScrambleDel - 4 : scrambler delete
• atomFunc - 5 : extras
• atomBombs - 6 : bomb behaviour
• atomGraphics - 7 : pixmaps
• atomMap - 8 : level map