teeworlds 2.4.4 → 2.4.7

package/lib/client.ts

@@ -5,12 +5,16 @@ import { EventEmitter } from 'stream';
 
 import { unpackString, MsgUnpacker } from "./MsgUnpacker";
 
-import Movement from './movement';
+import Movement from './components/movement';
+import { PlayerInput, PlayerInfo, Projectile, Laser, Pickup, Flag, GameInfo, GameData, CharacterCore, Character, ClientInfo, SpectatorInfo, Common, Explosion, Spawn, HammerHit, Death, SoundGlobal, SoundWorld, DamageInd } from "./snapshots";
 
 import { MsgPacker } from './MsgPacker';
-import { Snapshot } from './snapshot';
+import { Item, Snapshot } from './snapshot';
 import Huffman from "./huffman";
 import { Game } from "./components/game";
+import { SnapshotWrapper } from "./components/snapshot";
+
+import { UUIDManager } from "./UUIDManager";
 
 const huff = new Huffman();
 
@@ -104,6 +108,21 @@ enum NETMSG_Sys {
 	NETMSG_RCON_CMD_REM,
 
 	NUM_NETMSGS,
+
+	NETMSG_WHATIS = 65536,
+	NETMSG_ITIS,
+	NETMSG_IDONTKNOW,
+
+	NETMSG_RCONTYPE,
+	NETMSG_MAP_DETAILS,
+	NETMSG_CAPABILITIES,
+	NETMSG_CLIENTVER,
+	NETMSG_PINGEX,
+	NETMSG_PONGEX,
+	NETMSG_CHECKSUM_REQUEST,
+	NETMSG_CHECKSUM_RESPONSE,
+	NETMSG_CHECKSUM_ERROR
+
 }
 
 interface chunk {
@@ -118,9 +137,7 @@ interface chunk {
 	raw: Buffer,
 	extended_msgid?: Buffer;
 }
-function toHexStream(buff: Buffer): string {
-	return buff.toJSON().data.map(a => ('0' + (a & 0xff).toString(16)).slice(-2)).join("");
-}
+
 interface _packet {
 	twprotocol: { flags: number, ack: number, chunkAmount: number, size: number },
 	chunks: chunk[]
@@ -131,42 +148,7 @@ var messageTypes = [
 	["none, starts at 1", "INFO", "MAP_CHANGE", "MAP_DATA", "CON_READY", "SNAP", "SNAP_EMPTY", "SNAP_SINGLE", "INPUT_TIMING", "RCON_AUTH_STATUS", "RCON_LINE", "READY", "ENTER_GAME", "INPUT", "RCON_CMD", "RCON_AUTH", "REQUEST_MAP_DATA", "PING", "PING_REPLY", "RCON_CMD_ADD", "RCON_CMD_REMOVE"]
 ]
 
-var messageUUIDs = {
-	"WHAT_IS": Buffer.from([0x24, 0x5e, 0x50, 0x97, 0x9f, 0xe0, 0x39, 0xd6, 0xbf, 0x7d, 0x9a, 0x29, 0xe1, 0x69, 0x1e, 0x4c]),
-	"IT_IS": Buffer.from([0x69, 0x54, 0x84, 0x7e, 0x2e, 0x87, 0x36, 0x03, 0xb5, 0x62, 0x36, 0xda, 0x29, 0xed, 0x1a, 0xca]),
-	"I_DONT_KNOW": Buffer.from([0x41, 0x69, 0x11, 0xb5, 0x79, 0x73, 0x33, 0xbf, 0x8d, 0x52, 0x7b, 0xf0, 0x1e, 0x51, 0x9c, 0xf0]),
-	"RCON_TYPE": Buffer.from([0x12, 0x81, 0x0e, 0x1f, 0xa1, 0xdb, 0x33, 0x78, 0xb4, 0xfb, 0x16, 0x4e, 0xd6, 0x50, 0x59, 0x26]),
-	"MAP_DETAILS": Buffer.from([0xf9, 0x11, 0x7b, 0x3c, 0x80, 0x39, 0x34, 0x16, 0x9f, 0xc0, 0xae, 0xf2, 0xbc, 0xb7, 0x5c, 0x03]),
-	"CLIENT_VERSION": Buffer.from([0x8c, 0x00, 0x13, 0x04, 0x84, 0x61, 0x3e, 0x47, 0x87, 0x87, 0xf6, 0x72, 0xb3, 0x83, 0x5b, 0xd4]),
-	"CAPABILITIES": Buffer.from([0xf6, 0x21, 0xa5, 0xa1, 0xf5, 0x85, 0x37, 0x75, 0x8e, 0x73, 0x41, 0xbe, 0xee, 0x79, 0xf2, 0xb2]),
-}
-
-function arrStartsWith(arr: number[], arrStart: number[], start = 0) {
-	arr.splice(0, start)
-	for (let i = 0; i < arrStart.length; i++) {
-		if (arr[i] == arrStart[i])
-			continue;
-		else return false;
-	}
-	return true;
-}
-declare interface PlayerInfo {
-	local: number,
-	client_id: number,
-	team: number,
-	score: number,
-	latency: number,
-}
 
-declare interface ClientInfo {
-	name: string,
-	clan: string,
-	country: number,
-	skin: string,
-	use_custom_color: number,
-	color_body: number,
-	color_feet: number,
-}
 declare interface iMessage {
 	team: number,
 	client_id: number,
@@ -210,6 +192,10 @@ export declare interface Client {
 	on(event: 'kill', listener: (kill: iKillMsg) => void): this;
 	on(event: 'motd', listener: (message: string) => void): this;
 	
+	on(event: 'map_details', listener: (message: {map_name: string, map_sha256: Buffer, map_crc: number, map_size: number, map_url: string}) => void): this;
+	on(event: 'capabilities', listener: (message: {ChatTimeoutCode: boolean, AnyPlayerFlag: boolean, PingEx: boolean, AllowDummy: boolean, SyncWeaponInput: boolean}) => void): this;
+	
+	on(event: 'snapshot', listener: (items: Item[]) => void): this;
 }
 
 export class Client extends EventEmitter {
@@ -226,6 +212,8 @@ export class Client extends EventEmitter {
 	private time: number;
 	private SnapUnpacker: Snapshot;
 
+	public SnapshotUnpacker: SnapshotWrapper;
+
 	private PredGameTick: number;
 	private AckGameTick: number;
 	
@@ -253,6 +241,7 @@ export class Client extends EventEmitter {
 	public readonly options?: iOptions;
 	private requestResend: boolean;
 
+	private UUIDManager: UUIDManager;
   
 	constructor(ip: string, port: number, nickname: string, options?: iOptions) {
 		super();
@@ -265,7 +254,7 @@ export class Client extends EventEmitter {
 
 		this.SnapshotParts = 0;
 		
-		this.SnapUnpacker = new Snapshot();
+		this.SnapUnpacker = new Snapshot(this);
 		// this.eSnapHolder = [];
 		this.requestResend = false;
 		
@@ -293,10 +282,28 @@ export class Client extends EventEmitter {
 		this.lastRecvTime = new Date().getTime();
 
 		this.lastSentMessages = [];
+
 		this.movement = new Movement();
 		
 		this.game = new Game(this);
+		this.SnapshotUnpacker = new SnapshotWrapper(this);
 
+		this.UUIDManager = new UUIDManager();
+		
+		
+		this.UUIDManager.RegisterName("what-is@ddnet.tw", NETMSG_Sys.NETMSG_WHATIS);
+		this.UUIDManager.RegisterName("it-is@ddnet.tw", NETMSG_Sys.NETMSG_ITIS);
+		this.UUIDManager.RegisterName("i-dont-know@ddnet.tw", NETMSG_Sys.NETMSG_IDONTKNOW);
+
+		this.UUIDManager.RegisterName("rcon-type@ddnet.tw", NETMSG_Sys.NETMSG_RCONTYPE);
+		this.UUIDManager.RegisterName("map-details@ddnet.tw", NETMSG_Sys.NETMSG_MAP_DETAILS);
+		this.UUIDManager.RegisterName("capabilities@ddnet.tw", NETMSG_Sys.NETMSG_CAPABILITIES);
+		this.UUIDManager.RegisterName("clientver@ddnet.tw", NETMSG_Sys.NETMSG_CLIENTVER);
+		this.UUIDManager.RegisterName("ping@ddnet.tw", NETMSG_Sys.NETMSG_PING);
+		this.UUIDManager.RegisterName("pong@ddnet.tw", NETMSG_Sys.NETMSG_PONGEX);
+		this.UUIDManager.RegisterName("checksum-request@ddnet.tw", NETMSG_Sys.NETMSG_CHECKSUM_REQUEST);
+		this.UUIDManager.RegisterName("checksum-response@ddnet.tw", NETMSG_Sys.NETMSG_CHECKSUM_RESPONSE);
+		this.UUIDManager.RegisterName("checksum-error@ddnet.tw", NETMSG_Sys.NETMSG_CHECKSUM_ERROR);
 
 	}
 
@@ -347,12 +354,15 @@ export class Client extends EventEmitter {
 			chunk.msgid = (packet[0] - (packet[0] & 1)) / 2;
 			chunk.msg = messageTypes[packet[0] & 1][chunk.msgid];
 			chunk.raw = packet.slice(1, chunk.bytes)
-			Object.values(messageUUIDs).forEach((a, i) => {
-				if (a.byteLength >= 16 && a.compare(packet.slice(0, 16)) == 0) {
-					chunk.extended_msgid = a;
-					chunk.msg = Object.keys(messageUUIDs)[i];
+			if (chunk.msgid == 0 && chunk.raw.byteLength >= 16) {
+				let uuid = this.UUIDManager.LookupUUID(chunk.raw.slice(0, 16));
+				if (uuid !== undefined) {
+					chunk.extended_msgid = uuid.hash;
+					chunk.msg = uuid.name;
+					chunk.raw = chunk.raw.slice(16);
+					chunk.msgid = uuid.type_id;
 				}
-			})
+			}
 
 			packet = packet.slice(chunk.bytes) 
 			unpacked.chunks.push(chunk)
@@ -360,8 +370,9 @@ export class Client extends EventEmitter {
 		return unpacked
 	}
 
-	/* Send a Control Msg to the server. (used for disconnect)*/
-	SendControlMsg(msg: number, ExtraMsg: string = "") {
+	
+	/**  Send a Control Msg to the server. (used for disconnect)*/
+	SendControlMsg(msg: number, ExtraMsg: string = "") { 
 		this.lastSendTime = new Date().getTime();
 		return new Promise((resolve, reject) => {
 			if (this.socket) {
@@ -380,8 +391,9 @@ export class Client extends EventEmitter {
 		})
 	}
 
-	/* Send a Msg (or Msg[]) to the server.*/
-	SendMsgEx(Msgs: MsgPacker[] | MsgPacker) {
+	
+	/**  Send a Msg (or Msg[]) to the server.*/
+	SendMsgEx(Msgs: MsgPacker[] | MsgPacker, flags = 0) { 
 		if (this.State == States.STATE_OFFLINE)
 			return; 
 		if (!this.socket)
@@ -417,7 +429,7 @@ export class Client extends EventEmitter {
 					this.lastSentMessages.push({msg: Msg, ack: this.clientAck})
 			}
 		})
-		let flags = 0;
+		// let flags = 0;
 		if (this.requestResend)
 			flags |= 4;
 		
@@ -439,12 +451,14 @@ export class Client extends EventEmitter {
 			return;
 		this.socket.send(packet, 0, packet.length, this.port, this.host)
 	}
-	/* Queue a chunk (It will get sent in the next packet). */
+	
+	/** Queue a chunk (It will get sent in the next packet). */
 	QueueChunkEx(Msg: MsgPacker) {
 		this.queueChunkEx.push(Msg);
 	}
-	/* Send a Raw Buffer (as chunk) to the server. */
-	SendMsgRaw(chunks: Buffer[]) {
+	
+	/**  Send a Raw Buffer (as chunk) to the server. */
+	SendMsgRaw(chunks: Buffer[]) { 
 		if (this.State == States.STATE_OFFLINE)
 			return;
 		if (!this.socket)
@@ -476,17 +490,22 @@ export class Client extends EventEmitter {
 		chunk.msgid = (packet[0]-(packet[0]&1))/2;
 		chunk.msg = messageTypes[packet[0]&1][chunk.msgid];
 		chunk.raw = packet.slice(1, chunk.bytes)
-		Object.values(messageUUIDs).forEach((a, i) => {
-			if (a.byteLength >= 16 && a.compare(packet.slice(0, 16)) === 0) {
-				chunk.extended_msgid = a;
-				chunk.msg = Object.keys(messageUUIDs)[i];
-			}
-		})
+		if (chunk.msgid == 0) {
+			let uuid = this.UUIDManager.LookupUUID(chunk.raw.slice(0,16));
+			if (uuid !== undefined) {
+				chunk.extended_msgid = uuid.hash;
+				chunk.msgid = uuid.type_id;
+				chunk.msg = uuid.name;
+				chunk.raw = chunk.raw.slice(16);
+			}	
+			
+		}
 		return chunk;
 	}
 
-	/* Connect the client to the server. */
-	connect() {
+	
+	/** Connect the client to the server. */
+	connect() { 
 		this.State = States.STATE_CONNECTING;
 
 		let predTimer = setInterval(() => {
@@ -496,7 +515,7 @@ export class Client extends EventEmitter {
 			} else if (this.State == States.STATE_OFFLINE) 
 				clearInterval(predTimer);
 			
-		}, 20);
+		}, 1000/50); // 50 ticks per second
 
 		this.SendControlMsg(1, "TKEN")
 		let connectInterval = setInterval(() => {
@@ -513,7 +532,7 @@ export class Client extends EventEmitter {
 					return;
 				this.time = new Date().getTime();
 				this.sendInput();
-			}, 500)
+			}, 50)
 		}
 
 		let resendTimeout = setInterval(() => {
@@ -557,17 +576,15 @@ export class Client extends EventEmitter {
 
 						var client_version = new MsgPacker(0, true, 1);
 						client_version.AddBuffer(Buffer.from("8c00130484613e478787f672b3835bd4", 'hex'));
-						let randomUuid = Buffer.allocUnsafe(16);
-
-						randomBytes(16).copy(randomUuid);
+						let randomUuid = randomBytes(16);
 
 						client_version.AddBuffer(randomUuid);
 						if (this.options?.ddnet_version !== undefined) {
 							client_version.AddInt(this.options?.ddnet_version.version);
 							client_version.AddString("DDNet " + this.options?.ddnet_version.release_version);
 						} else {
-							client_version.AddInt(16003);
-							client_version.AddString("DDNet 16.0.3");
+							client_version.AddInt(16050);
+							client_version.AddString("DDNet 16.5.0");
 						}
 		
 						this.SendMsgEx([client_version, info])
@@ -714,12 +731,12 @@ export class Client extends EventEmitter {
 
 								let snapUnpacked = this.SnapUnpacker.unpackSnapshot(mergedSnaps, DeltaTick, GameTick, Crc);
 								
-								this.emit("snapshot");
+								this.emit("snapshot", snapUnpacked.items);
 								this.AckGameTick = snapUnpacked.recvTick;
-								if (Math.abs(this.PredGameTick - this.AckGameTick) > 10)
+								if (Math.abs(this.PredGameTick - this.AckGameTick) > 10) {
 									this.PredGameTick = this.AckGameTick + 1;
-
-								this.sendInput();
+									this.sendInput();
+								}
 							} 
 
 
@@ -729,7 +746,93 @@ export class Client extends EventEmitter {
 					// })
 
 
-				}
+						}
+						
+						if (chunk.msgid >= NETMSG_Sys.NETMSG_WHATIS && chunk.msgid <= NETMSG_Sys.NETMSG_CHECKSUM_ERROR) {
+							if (chunk.msgid == NETMSG_Sys.NETMSG_WHATIS) {
+								let Uuid = chunk.raw.slice(0, 16);
+
+								let uuid = this.UUIDManager.LookupUUID(Uuid);
+								let packer = new MsgPacker(0, true, 1);
+								if (uuid !== undefined) {
+									// IT_IS msg
+									packer.AddBuffer(this.UUIDManager.LookupType(NETMSG_Sys.NETMSG_ITIS)!.hash);
+									
+									packer.AddBuffer(Uuid);
+									packer.AddString(uuid.name);
+								} else {
+									// dont_know msg
+									packer.AddBuffer(this.UUIDManager.LookupType(NETMSG_Sys.NETMSG_IDONTKNOW)!.hash);
+									
+									packer.AddBuffer(Uuid);
+								}
+								this.QueueChunkEx(packer)
+							}
+
+							if (chunk.msgid == NETMSG_Sys.NETMSG_MAP_DETAILS) { // TODO: option for downloading maps
+								let unpacker = new MsgUnpacker(chunk.raw);
+
+								let map_name = unpacker.unpackString();
+								let map_sha256: Buffer = Buffer.alloc(32);
+								if (unpacker.remaining.length >= 32)
+									map_sha256 = unpacker.unpackRaw(32);
+								let map_crc = unpacker.unpackInt();
+								let map_size = unpacker.unpackInt();
+
+								let map_url = "";
+								if (unpacker.remaining.length) 
+									map_url = unpacker.unpackString();
+								
+								this.emit("map_details", {map_name, map_sha256, map_crc, map_size, map_url})
+								// unpacker.unpack
+
+							} else if (chunk.msgid == NETMSG_Sys.NETMSG_CAPABILITIES) {
+								let unpacker = new MsgUnpacker(chunk.raw);
+								let Version = unpacker.unpackInt();
+								let Flags = unpacker.unpackInt();
+								if (Version <= 0)
+									return;
+								let DDNet = false;
+								if (Version >= 1) {
+									DDNet = Boolean(Flags & 1);
+									
+								}
+								let ChatTimeoutCode = DDNet;
+								let AnyPlayerFlag = DDNet;
+								let PingEx = false;
+								let AllowDummy = true;
+								let SyncWeaponInput = false;
+								if(Version >= 1)
+								{
+									ChatTimeoutCode = Boolean(Flags & 2);
+								}
+								if(Version >= 2)
+								{
+									AnyPlayerFlag = Boolean(Flags & 4);
+								}
+								if(Version >= 3)
+								{
+									PingEx = Boolean(Flags & 8);
+								}
+								if(Version >= 4)
+								{
+									AllowDummy = Boolean(Flags & 16);
+								}
+								if(Version >= 5)
+								{
+									SyncWeaponInput = Boolean(Flags & 32);
+								}
+								this.emit("capabilities", {ChatTimeoutCode, AnyPlayerFlag, PingEx, AllowDummy, SyncWeaponInput});
+								// https://github.com/ddnet/ddnet/blob/06e3eb564150e9ab81b3a5595c48e9fe5952ed32/src/engine/client/client.cpp#L1565
+							} else if (chunk.msgid == NETMSG_Sys.NETMSG_PINGEX) {
+								let packer = new MsgPacker(0, true, 2);
+								packer.AddBuffer(this.UUIDManager.LookupType(NETMSG_Sys.NETMSG_PONGEX)!.hash);
+
+								this.SendMsgEx(packer, 2);
+							}
+
+						}
+
 					} else { 
 						// game messages
 
@@ -743,7 +846,7 @@ export class Client extends EventEmitter {
 							for (let i = 0; i < 15; i++) {
 								list.push(unpacker.unpackString());
 							}
-							list = list.slice(NumOptions);
+							list = list.slice(0, NumOptions);
 
 							this.VoteList.push(...list);
 						} else if (chunk.msgid == NETMSG_Game.SV_VOTEOPTIONADD) {
@@ -770,8 +873,8 @@ export class Client extends EventEmitter {
 
 							if (unpacked.client_id != -1) {
 								unpacked.author = { 
-									ClientInfo: this.client_info(unpacked.client_id), 
-									PlayerInfo: this.player_info(unpacked.client_id) 
+									ClientInfo: this.SnapshotUnpacker.getObjClientInfo(unpacked.client_id), 
+									PlayerInfo: this.SnapshotUnpacker.getObjPlayerInfo(unpacked.client_id) 
 								}
 							}
 							this.emit("emote", unpacked)
@@ -792,8 +895,8 @@ export class Client extends EventEmitter {
 
 							if (unpacked.client_id != -1) {
 								unpacked.author = { 
-									ClientInfo: this.client_info(unpacked.client_id), 
-									PlayerInfo: this.player_info(unpacked.client_id) 
+									ClientInfo: this.SnapshotUnpacker.getObjClientInfo(unpacked.client_id), 
+									PlayerInfo: this.SnapshotUnpacker.getObjPlayerInfo(unpacked.client_id) 
 								}
 							}
 							this.emit("message", unpacked)
@@ -805,11 +908,11 @@ export class Client extends EventEmitter {
 							unpacked.weapon = unpacker.unpackInt();
 							unpacked.special_mode = unpacker.unpackInt();
 							if (unpacked.victim_id != -1 && unpacked.victim_id < 64) {
-								unpacked.victim = { ClientInfo: this.client_info(unpacked.victim_id), PlayerInfo: this.player_info(unpacked.victim_id) }
+								unpacked.victim = { ClientInfo: this.SnapshotUnpacker.getObjClientInfo(unpacked.victim_id), PlayerInfo: this.SnapshotUnpacker.getObjPlayerInfo(unpacked.victim_id) }
 
 							}
 							if (unpacked.killer_id != -1 && unpacked.killer_id < 64)
-								unpacked.killer = { ClientInfo: this.client_info(unpacked.killer_id), PlayerInfo: this.player_info(unpacked.killer_id) }
+								unpacked.killer = { ClientInfo: this.SnapshotUnpacker.getObjClientInfo(unpacked.killer_id), PlayerInfo: this.SnapshotUnpacker.getObjPlayerInfo(unpacked.killer_id) }
 							this.emit("kill", unpacked)
 						} else if (chunk.msgid == NETMSG_Game.SV_MOTD) {
 							let unpacker = new MsgUnpacker(chunk.raw);
@@ -834,8 +937,9 @@ export class Client extends EventEmitter {
 			})
 	}
 
-	/* Sending the input. (automatically done unless options.lightweight is on) */
-	sendInput(input = this.movement.input) {
+	
+	/** Sending the input. (automatically done unless options.lightweight is on) */
+	sendInput(input = this.movement.input) { 
 		if (this.State != States.STATE_ONLINE)
 			return;
 
@@ -857,12 +961,14 @@ export class Client extends EventEmitter {
 		
 		this.SendMsgEx(inputMsg);
 	}
-	get input() {
+	/** returns the movement object of the client */
+	get input() { 
 		return this.movement.input;
 	}
 
-	/* Disconnect the client. */
-	Disconnect() {
+	
+	/** Disconnect the client. */
+	Disconnect() { 
 		return new Promise((resolve) => {
 			this.SendControlMsg(4).then(() => {
 				resolve(true);
@@ -874,46 +980,11 @@ export class Client extends EventEmitter {
 		})
 	}
 
-	/* Get the client_info from a specific player id. */
-	client_info(id: number) {
-		let delta = this.SnapUnpacker.deltas.filter(_delta => 
-			_delta.type_id == 11 
-			&& _delta.id == id
-		);
-
-		if (delta.length == 0)
-			return undefined;
-		return delta[0].parsed as ClientInfo;
-			// .sort((a, b) => a.id - b.id)
-			// .map(a => a.parsed as ClientInfo);
-	}
-
-	/* Get all client infos. */
-	get client_infos(): ClientInfo[] {
-		
-		return this.SnapUnpacker.deltas.filter(_delta => _delta.type_id == 11)
-		.sort((a, b) => a.id - b.id)
-		.map(a => a.parsed as ClientInfo);
-	}
-	/* Get the player info from a specific player id. */
-	player_info(id: number) {
-		let delta = this.SnapUnpacker.deltas.filter(_delta => 
-			_delta.type_id == 10
-			&& _delta.id == id
-		);
-
-		if (delta.length == 0)
-			return undefined;
-		return delta[0].parsed as PlayerInfo;
-	}
-	/* Get all player infos. */
-	get player_infos(): PlayerInfo[] {
-		return this.SnapUnpacker.deltas.filter(_delta => _delta.type_id == 10)
-			.sort((a, b) => a.id - b.id)
-			.map(player => player.parsed as PlayerInfo);
-	}
-
-	get VoteOptionList(): string[] {
+	/** Get all available vote options (for example for map voting) */
+	get VoteOptionList(): string[] { 
 		return this.VoteList;
 	}
+	get rawSnapUnpacker(): Snapshot {
+		return this.SnapUnpacker;
+	}
 }

package/lib/components/game.js

@@ -59,19 +59,19 @@ var Game = /** @class */ (function () {
         packer.AddString(message);
         this.send(packer);
     };
-    /* Set the team of an bot. (-1 spectator team, 0 team red/normal team, 1 team blue) */
+    /** Set the team of an bot. (-1 spectator team, 0 team red/normal team, 1 team blue) */
     Game.prototype.SetTeam = function (team) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_SETTEAM, false, 1);
         packer.AddInt(team);
         this.send(packer);
     };
-    /* Spectate an player, taking their id as parameter. pretty useless */
+    /** Spectate an player, taking their id as parameter. pretty useless */
     Game.prototype.SpectatorMode = function (SpectatorID) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_SETSPECTATORMODE, false, 1);
         packer.AddInt(SpectatorID);
         this.send(packer);
     };
-    /* Change the player info */
+    /** Change the player info */
     Game.prototype.ChangePlayerInfo = function (playerInfo) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_CHANGEINFO, false, 1);
         packer.AddString(playerInfo.name);
@@ -83,18 +83,18 @@ var Game = /** @class */ (function () {
         packer.AddInt(playerInfo.color_feet);
         this.send(packer);
     };
-    /* Kill */
+    /** Kill */
     Game.prototype.Kill = function () {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_KILL, false, 1);
         this.send(packer);
     };
-    /* Send emote */
+    /** Send emote */
     Game.prototype.Emote = function (emote) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_EMOTICON, false, 1);
         packer.AddInt(emote);
         this.send(packer);
     };
-    /* Vote for an already running vote (f3 / f4) */
+    /** Vote for an already running vote (true = f3 /  false = f4) */
     Game.prototype.Vote = function (vote) {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_VOTE, false, 1);
         packer.AddInt(vote ? 1 : -1);
@@ -107,24 +107,24 @@ var Game = /** @class */ (function () {
         packer.AddString(Reason);
         this.send(packer);
     };
-    /* Call a vote for an server option (for example ddnet maps) */
+    /** Call a vote for an server option (for example ddnet maps) */
     Game.prototype.CallVoteOption = function (Value, Reason) {
         this.CallVote("option", Value, Reason);
     };
-    /* Call a vote to kick a player. Requires the player id */
+    /** Call a vote to kick a player. Requires the player id */
     Game.prototype.CallVoteKick = function (PlayerID, Reason) {
         this.CallVote("kick", PlayerID, Reason);
     };
-    /* Call a vote to set a player in spectator mode. Requires the player id */
+    /** Call a vote to set a player in spectator mode. Requires the player id */
     Game.prototype.CallVoteSpectate = function (PlayerID, Reason) {
         this.CallVote("spectate", PlayerID, Reason);
     };
-    /** probably some verification of using ddnet client.*/
+    /** probably some verification of using ddnet client. */
     Game.prototype.IsDDNetLegacy = function () {
         var packer = new MsgPacker_1.MsgPacker(NETMSGTYPE.CL_ISDDNETLEGACY, false, 1);
         this.send(packer);
     };
-    /* returns the ping in ms */
+    /** returns the ping in ms (as a promise) */
     Game.prototype.Ping = function () {
         var _this = this;
         return new Promise(function (resolve, reject) {