protocol.h

 
#ifndef LIBSPADES_PROTOCOL_H
#define LIBSPADES_PROTOCOL_H
#ifdef __cplusplus
extern "C" {
#endif
 
#include "../config.h"
#include "datatypes.h"
 
#define VARIABLE_LENGTH 1
 
#ifdef PACK_GCC
#define LIBSPADES_PACKED __attribute__((packed))
#else
#pragma pack(push, 1)
#define LIBSPADES_PACKED
#endif
 
/* core protocol packet structs */

struct LIBSPADES_PACKED PacketPositionData {
    uint8_t packetID; 
    float xPosition;  
    float yPosition;  
    float zPosition;  
};

struct LIBSPADES_PACKED PacketOrientationData {
    uint8_t packetID;   
    float xOrientation; 
    float yOrientation; 
    float zOrientation; 
};
 
struct LIBSPADES_PACKED PlayerPositionData {
    float xPosition;
    float yPosition;
    float zPosition;
    float xOrientation;
    float yOrientation;
    float zOrientation;
};
 
struct LIBSPADES_PACKED PlayerPositionData76 {
    uint8_t playerID;
    float xPosition;
    float yPosition;
    float zPosition;
    float xOrientation;
    float yOrientation;
    float zOrientation;
};

struct LIBSPADES_PACKED PacketWorldUpdate {             /* do 0.76 version later */
    uint8_t packetID;                               
    struct PlayerPositionData players[MAX_PLAYERS]; 
};

struct LIBSPADES_PACKED PacketInputData {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t keyStates;
};

struct LIBSPADES_PACKED PacketWeaponInput {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t weaponInput;
};

struct LIBSPADES_PACKED PacketHit {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t hitType;
};

struct LIBSPADES_PACKED PacketSetHP {
    uint8_t packetID; 
    uint8_t HP;       
    uint8_t type;
    float sourceX; 
    float sourceY; 
    float sourceZ; 
};

struct LIBSPADES_PACKED PacketGrenade {
    uint8_t packetID; 
    uint8_t playerID; 
    float fuseLength;
    float xPosition; 
    float yPosition; 
    float zPosition; 
    float xVelocity; 
    float yVelocity; 
    float zVelocity; 
};

struct LIBSPADES_PACKED PacketSetTool {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t tool;
};

struct LIBSPADES_PACKED PacketSetColour {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t blue; /* TODO: use b,g,r
                                                                                                               xor
                                                                                                               blue,green,red
                                                                                                             */
    uint8_t green;                                      
    uint8_t red;                                        
};

struct LIBSPADES_PACKED PacketExistingPlayer {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t team;     
    uint8_t weapon;
    uint8_t item;
    uint32_t kills; /* or points? */
    uint8_t blue;                               
    uint8_t green;                              
    uint8_t red;                                
    char name[16];
};

struct LIBSPADES_PACKED PacketShortPlayerData {
    uint8_t packetID; 
    uint8_t playerID;
    uint8_t team;   
    uint8_t weapon; 
};

struct LIBSPADES_PACKED PacketMoveObject {
    uint8_t packetID; 
    uint8_t objectID;
    uint8_t team; /* unsigned int is intentional for some reason, check the
                                     aosprotocol docs */
    float xPosition;
    float yPosition;
    float zPosition;
};

struct LIBSPADES_PACKED PacketCreatePlayer {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t weapon;   
    uint8_t team;     
    float xPosition;  
    float yPosition;  
    float zPosition;  
    char name[16];
    /* or connected?? TODO: verify */
};

struct LIBSPADES_PACKED PacketBlockAction {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t actionType;
    int32_t xPosition; 
    int32_t yPosition; 
    int32_t zPosition; 
};

struct LIBSPADES_PACKED PacketBlockLine {
    uint8_t packetID;        
    uint8_t playerID;        
    uint32_t startXPosition; 
    uint32_t startYPosition; 
    uint32_t startZPosition; 
    uint32_t endXPosition;   
    uint32_t endYPosition;   
    uint32_t endZPosition;   
};
 
struct LIBSPADES_PACKED FloatVector {
    float x;
    float y;
    float z;
};
 
union IntelLocation {
    uint8_t playerID;      
    Vector3Float position; 
};

struct LIBSPADES_PACKED CTFStateData {
    uint8_t team1Score;   
    uint8_t team2Score;   
    uint8_t captureLimit; 
    uint8_t heldIntels;
    union IntelLocation team1Intel; 
    union IntelLocation team2Intel; 
    Vector3Float team1TentPosition; 
    Vector3Float team2TentPosition; 
};
 
struct LIBSPADES_PACKED Territory {
    float xPosition; 
    float yPosition; 
    float zPosition; 
    uint8_t team;    
};

struct LIBSPADES_PACKED TCStateData {
    uint8_t territoryCount; 
    struct Territory territories[16];
};

union GamemodeData {
    struct CTFStateData ctfStateData; 
    struct TCStateData tcStateData;   
};

struct LIBSPADES_PACKED PacketStateData { /* TODO: shoehorn gamemode state data in later */
    uint8_t packetID;                 
    uint8_t playerID;                 
    uint8_t fog_b;                    
    uint8_t fog_g;                    
    uint8_t fog_r;                    
    uint8_t team1_b;                  
    uint8_t team1_g;                  
    uint8_t team1_r;                  
    uint8_t team2_b;                  
    uint8_t team2_g;                  
    uint8_t team2_r;                  
    char team1Name[10];               
    char team2Name[10];               
    uint8_t gamemode;
    union GamemodeData gamemodeData; 
};

struct LIBSPADES_PACKED PacketKillAction {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t killerID; 
    uint8_t killType;
    uint8_t respawnTime;
};

struct LIBSPADES_PACKED PacketChatMessage {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t type;
    char message[VARIABLE_LENGTH]; 
};

struct LIBSPADES_PACKED PacketMapStart {
    uint8_t packetID; 
    uint32_t mapSize; 
};

struct LIBSPADES_PACKED PacketMapStart76 {
    uint8_t packetID;                              
    uint32_t mapSize;                              
    uint32_t crc32;                                
    char mapName[16];  /* may not actually work */
};

struct LIBSPADES_PACKED PacketMapChunk {
    uint8_t packetID;                 
    uint8_t mapData[VARIABLE_LENGTH]; 
};

struct LIBSPADES_PACKED PacketPlayerLeft {
    uint8_t packetID; 
    uint8_t playerID; 
};

struct LIBSPADES_PACKED PacketTerritoryCapture {
    uint8_t packetID; 
    uint8_t territoryID; 
    uint8_t winning; 
    uint8_t team; 
};

struct LIBSPADES_PACKED PacketProgressBar {
    uint8_t packetID; 
    uint8_t entityID;
    uint8_t capturingTeam;
    int8_t rate;
    float progress;
};

struct LIBSPADES_PACKED PacketIntelCapture {
    uint8_t packetID; 
    uint8_t playerID; 
    uint8_t winning;  
};

struct LIBSPADES_PACKED PacketIntelPickup {
    uint8_t packetID; 
    uint8_t playerID; 
};

struct LIBSPADES_PACKED PacketIntelDrop {
    uint8_t packetID;      
    uint8_t playerID;      
    Vector3Float position; 
};

struct LIBSPADES_PACKED PacketRestock {
    uint8_t packetID; 
    uint8_t playerID; 
};

struct LIBSPADES_PACKED PacketFogColour {
    uint8_t packetID;
    uint8_t a; 
    uint8_t b; 
    uint8_t g; 
    uint8_t r; 
};

struct LIBSPADES_PACKED PacketWeaponReload {
    uint8_t packetID;     
    uint8_t playerID;     
    uint8_t magazineAmmo; 
    uint8_t reserveAmmo;  
};

struct LIBSPADES_PACKED PacketChangeTeam {
    uint8_t packetID;
    uint8_t playerID; 
    uint8_t teamID;
};

struct LIBSPADES_PACKED PacketChangeWeapon {
    uint8_t packetID;
    uint8_t playerID; 
    uint8_t weaponID;
};

struct LIBSPADES_PACKED PacketMapCached {
    uint8_t packetID; 
    uint8_t cached;   
};
 
/* extension packet structs */

struct LIBSPADES_PACKED ExtensionInfoEntry {
    uint8_t extensionID;      
    uint8_t extensionVersion; 
};

struct LIBSPADES_PACKED PacketExtensionInfo {
    uint8_t packetID;                                   
    uint8_t length;                                     
    struct ExtensionInfoEntry entries[VARIABLE_LENGTH]; 
};

struct LIBSPADES_PACKED PacketHandShakeInit {
    uint8_t packetID;   
    uint32_t challenge; 
};

struct LIBSPADES_PACKED PacketHandShakeReturn { /* just a copy of PacketHandShakeInit but whatever */
    uint8_t packetID;                       
    uint32_t challenge;                     
};

struct LIBSPADES_PACKED PacketVersionRequest {
    uint8_t packetID; 
};

struct LIBSPADES_PACKED PacketVersionResponse {
    uint8_t packetID; 
    char client;
    uint8_t versionMajor;    
    uint8_t versionMinor;    
    uint8_t versionRevision; 
    char operatingSystemInfo[VARIABLE_LENGTH];
};

struct LIBSPADES_PACKED PacketPlayerProperties {
    uint8_t packetID;     
    uint8_t subPacketID;  
    uint8_t playerID;     
    uint8_t HP;           
    uint8_t blocks;       
    uint8_t grenades;     
    uint8_t magazineAmmo; 
    uint8_t reserveAmmo;  
    uint32_t score;       
};

struct LIBSPADES_PACKED PacketRequestAuthentication {
    uint8_t packetID;    
    uint8_t subPacketID; 
};

struct LIBSPADES_PACKED PacketEndAuthentication {
    uint8_t packetID;    
    uint8_t subPacketID; 
    uint8_t success;     
    char permissionLevel[VARIABLE_LENGTH]; 
};

struct LIBSPADES_PACKED PacketSendPublicKey {
    uint8_t packetID;      
    uint8_t subPacketID;   
    uint8_t publicKey[32]; 
};

struct LIBSPADES_PACKED PacketSendNonce {
    uint8_t packetID;               
    uint8_t subPacketID;            
    uint8_t nonce[VARIABLE_LENGTH]; 
};

struct LIBSPADES_PACKED PacketSendSignature {
    uint8_t packetID;      
    uint8_t subPacketID;   
    uint8_t signature[64]; 
};
 
#ifndef PACK_GCC
#pragma pack(pop)
#endif
 
enum PacketType {
    PacketTypePositionData = 0,      /* Client<->Server */
    PacketTypeOrientationData = 1,   /* usually Client-->Server, but Client<->Server is possible */
    PacketTypeWorldUpdate = 2,       /* Client<--Server */
    PacketTypeInputData = 3,         /* Client<->Server */
    PacketTypeWeaponInput = 4,       /* Client<->Server */
    PacketTypeHit = 5,               /* Client-->Server */
    PacketTypeSetHP = 5,             /* Client<--Server */
    PacketTypeGrenade = 6,           /* Client<->Server */
    PacketTypeSetTool = 7,           /* Client<->Server */
    PacketTypeSetColour = 8,         /* Client<->Server */
    PacketTypeExistingPlayer = 9,    /* Client<->Server */
    PacketTypeShortPlayerData = 10,  /* Client---Server */
    PacketTypeMoveObject = 11,       /* Client<--Server */
    PacketTypeCreatePlayer = 12,     /* Client<--Server */
    PacketTypeBlockAction = 13,      /* Client<->Server */
    PacketTypeBlockLine = 14,        /* Client<->Server */
    PacketTypeStateData = 15,        /* Client<--Server */
    PacketTypeKillAction = 16,       /* Client<--Server */
    PacketTypeChatMessage = 17,      /* Client<->Server */
    PacketTypeMapStart = 18,         /* Client<--Server */
    PacketTypeMapChunk = 19,         /* Client<--Server */
    PacketTypePlayerLeft = 20,       /* Client<--Server */
    PacketTypeTerritoryCapture = 21, /* Client<--Server */
    PacketTypeProgressBar = 22,      /* Client<--Server */
    PacketTypeIntelCapture = 23,     /* Client<--Server */
    PacketTypeIntelPickup = 24,      /* Client<--Server */
    PacketTypeIntelDrop = 25,        /* Client<--Server */
    PacketTypeRestock = 26,          /* Client<--Server */
    PacketTypeFogColour = 27,        /* Client<--Server */
    PacketTypeWeaponReload = 28,     /* Client<->Server */
    PacketTypeChangeTeam = 29,       /* Client-->Server */
    PacketTypeChangeWeapon = 30,     /* Client<->Server */
    PacketTypeMapCached = 31,        /* Client-->Server */
 
    /* extension packets. NOTE: for most servers, you must complete the
       HandShakeInit and Return to gain access to extensions. */
    PacketTypeHandShakeInit = 31,   /* Client<--Server */
    PacketTypeHandShakeReturn = 32, /* Client-->Server */
    PacketTypeVersionRequest = 33,
    /* Client<--Server */ /* sent before extension info is provided */
    PacketTypeVersionResponse = 34,
    /* Client-->Server */ /* sendable before extension info is provided */
 
    PacketTypeExtensionInfo = 60, /* Client<->Server */
 
    PacketTypePlayerProperties = 64,
    PacketTypeEd25519Authentication = 65
    /* I wonder if it would just be better to have all the subpackets for this? */
};
 
enum SubPacketType {
    /* PacketTypePlayerProperties */
    SubPacketTypePlayerProperties = 0, /* Client<--Server */
 
    /* PacketTypeEd25519Authentication */
    SubPacketTypeRequestAuthentication = 0, /* Client<--Server */
    SubPacketTypeEndAuthentication = 1,     /* Client<--Server */
    SubPacketTypeSendPublicKey = 2,         /* Client-->Server */
    SubPacketTypeSendNonce = 3,             /* Client<--Server */
    SubPacketTypeSendSignature = 4          /* Client-->Server */
};
 
enum WeaponType { WeaponTypeRifle = 0, WeaponTypeSMG = 1, WeaponTypeShotgun = 2 };
 
enum BlockActionType {
    BlockActionTypeBuild = 0,
    BlockActionTypeSpadeGunDestroy = 1,
    BlockActionTypeSpadeSecondaryDestroy = 2,
    BlockActionTypeGrenadeDestroy = 3
};
 
enum HurtType { HurtTypeFall = 0, HurtTypeWeapon = 1 };
 
enum ChatType { ChatTypeAll = 0, ChatTypeTeam = 1, ChatTypeSystem = 2 };
 
/* Might or might not want to use the defines instead in new things. Probably doesn't matter too much.
 * The defines are there since enum uses signed int, which does not work for the CRC32.
 */
enum ProtocolVersion { ProtocolVersion75 = 3, ProtocolVersion76 = 4 };
 
#define LIBSPADES_PROTOCOL_VERSION_10     0
#define LIBSPADES_PROTOCOL_VERSION_21     0
#define LIBSPADES_PROTOCOL_VERSION_22     0
/* Most of these are a CRC32 of client.exe */
#define LIBSPADES_PROTOCOL_VERSION_26     0x40950dbb
#define LIBSPADES_PROTOCOL_VERSION_30     0x7965ce91
#define LIBSPADES_PROTOCOL_VERSION_31     0x7965ce91
#define LIBSPADES_PROTOCOL_VERSION_32     0x7a8660d4
#define LIBSPADES_PROTOCOL_VERSION_33     0x709cc6e3
#define LIBSPADES_PROTOCOL_VERSION_35     0xf39348d7
#define LIBSPADES_PROTOCOL_VERSION_36     0x4da4f41e
#define LIBSPADES_PROTOCOL_VERSION_40     0xa3937cd0
#define LIBSPADES_PROTOCOL_VERSION_41     0xa3937cd0
#define LIBSPADES_PROTOCOL_VERSION_42     0x09e3c405
#define LIBSPADES_PROTOCOL_VERSION_46     0x0e240254
#define LIBSPADES_PROTOCOL_VERSION_47     0x9217d00e
#define LIBSPADES_PROTOCOL_VERSION_48     0x187532bf
#define LIBSPADES_PROTOCOL_VERSION_49     0xb2aa66f5
#define LIBSPADES_PROTOCOL_VERSION_50     0x1fcb39d1
#define LIBSPADES_PROTOCOL_VERSION_51     0x679b3c4d
#define LIBSPADES_PROTOCOL_VERSION_52     0x9c8791f8
#define LIBSPADES_PROTOCOL_VERSION_53     0x2aecbe65
#define LIBSPADES_PROTOCOL_VERSION_54     0x4e849539
#define LIBSPADES_PROTOCOL_VERSION_55     0x20791226
#define LIBSPADES_PROTOCOL_VERSION_58     0xad004b4e
#define LIBSPADES_PROTOCOL_VERSION_60_009 0x75894111
#define LIBSPADES_PROTOCOL_VERSION_60_010 0xc7e8dab2
#define LIBSPADES_PROTOCOL_VERSION_60_011 0xea5e9039
#define LIBSPADES_PROTOCOL_VERSION_60_014 0x607521b0
#define LIBSPADES_PROTOCOL_VERSION_60     LIBSPADES_PROTOCOL_VERSION_60_014
#define LIBSPADES_PROTOCOL_VERSION_61_004 0x16165bae
#define LIBSPADES_PROTOCOL_VERSION_61_005 0x8ab03b5f
#define LIBSPADES_PROTOCOL_VERSION_61_006 0x9e592202
#define LIBSPADES_PROTOCOL_VERSION_61     LIBSPADES_PROTOCOL_VERSION_61_006
#define LIBSPADES_PROTOCOL_VERSION_62_003 0x13575615
#define LIBSPADES_PROTOCOL_VERSION_62_006 0x3da3f698
#define LIBSPADES_PROTOCOL_VERSION_62     LIBSPADES_PROTOCOL_VERSION_62_006
#define LIBSPADES_PROTOCOL_VERSION_70_008 0x9f4fe987
#define LIBSPADES_PROTOCOL_VERSION_70_009 0x7a4139b6
#define LIBSPADES_PROTOCOL_VERSION_70_012 0xb0525b7e
/* No idea where this number came from. Not a CRC32 of that version's client.exe, anyway. */
#define LIBSPADES_PROTOCOL_VERSION_70_017 0xdc05cbda
#define LIBSPADES_PROTOCOL_VERSION_70     LIBSPADES_PROTOCOL_VERSION_70_017
#define LIBSPADES_PROTOCOL_VERSION_75_003 1
#define LIBSPADES_PROTOCOL_VERSION_75_004 1
#define LIBSPADES_PROTOCOL_VERSION_75_007 1
#define LIBSPADES_PROTOCOL_VERSION_75_009 1
#define LIBSPADES_PROTOCOL_VERSION_75_010 2
#define LIBSPADES_PROTOCOL_VERSION_75_011 2
#define LIBSPADES_PROTOCOL_VERSION_75_013 3
#define LIBSPADES_PROTOCOL_VERSION_75_015 3
#define LIBSPADES_PROTOCOL_VERSION_75     LIBSPADES_PROTOCOL_VERSION_75_015
#define LIBSPADES_PROTOCOL_VERSION_76_010 4
#define LIBSPADES_PROTOCOL_VERSION_76     LIBSPADES_PROTOCOL_VERSION_76_010
 
enum ItemType {
    ItemTypeSpade = 0,
    ItemTypeBlock = 1,
    ItemTypeGun = 2,
    ItemTypeGrenade = 3
}; /* FIXME: disambiguate item/tool */
 
enum KillType {
    KillTypeWeapon = 0,
    KillTypeHeadshot = 1,
    KillTypeMelee = 2,
    KillTypeGrenade = 3,
    KillTypeFall = 4,
    KillTypeTeamChange = 5,
    KillTypeClassChange = 6 /* FIXME: weapon change? */
};
 
enum WeaponInputType { WeaponInputTypePrimary = 1, WeaponInputTypeSecondary = 2 };
 
enum HitType { HitTypeTorso = 0, HitTypeHead = 1, HitTypeArms = 2, HitTypeLegs = 3, HitTypeMelee = 4 };
 
enum KeyStateType {
    KeyStateTypeForward = 1,
    KeyStateTypeBackward = 2,
    KeyStateTypeLeft = 4,
    KeyStateTypeRight = 8,
    KeyStateTypeJump = 16,
    KeyStateTypeCrouch = 32,
    KeyStateTypeSneak = 64,
    KeyStateTypeSprint = 128
};

enum ExtensionID {
    /* Extensions with packets */
    ExtensionIDPlayerProperties = 0,      
    ExtensionIDEd25519Authentication = 1, 
 
    /* Extensions without packets */
    ExtensionID256Players = 192,   
    ExtensionIDMessageTypes = 193, 
    ExtensionIDKickReason = 194    
};
 
enum MagazineAmmoSize { MagazineAmmoSizeRifle75 = 10, MagazineAmmoSizeSMG75 = 30, MagazineAmmoSizeShotgun75 = 6 };
 
enum ReserveAmmoSize { ReserveAmmoSizeRifle75 = 50, ReserveAmmoSizeSMG75 = 120, ReserveAmmoSizeShotgun75 = 48 };
 
enum FireDelayMilliseconds {
    FireDelayMillisecondsRifle75 = 500,
    FireDelayMillisecondsSMG75 = 100,
    FireDelayMillisecondsShotgun75 = 1000
};
 
enum PelletQuantity { PelletQuantityRifle75 = 1, PelletQuantitySMG75 = 1, PelletQuantityShotgun75 = 8 };
 
enum GamemodeType { GamemodeTypeCTF = 0, GamemodeTypeTC = 1 };
 
#ifdef __cplusplus
}
#endif
#endif