teeworlds 2.4.7 → 2.4.9

package/README.md

@@ -1,6 +1,7 @@
 # tw-chatonly
 Library to connect a bot to a Teeworlds server.
 
+https://gitlab.com/swarfey/teeworlds-client/-/tree/main/
 https://www.npmjs.com/package/teeworlds
 
 
@@ -87,3 +88,7 @@ process.stdin.on("data", data => {
 	
 })
 ```
+
+# Documentation
+You can find an documentation to what most components do in the [docs/documentation.md](https://gitlab.com/swarfey/teeworlds-client/-/blob/main/docs/documentation.md).
+You can also find a few examples inside of the [docs/examples](https://gitlab.com/swarfey/teeworlds-client/-/tree/main/docs/examples) directory.

package/docs/{events.md → documentation.md}

@@ -299,7 +299,7 @@ The movement component is accessable using `client.movement`.
 * RunRight()
 	* makes the client run right
 * RunStop()
-	* makes the client stop running (if he is)
+	* makes the client stop running (if he is)
 * Jump(state?: boolean)
 	* makes the client Jump. if the parameter is false, the bot will stop holding jump.
 * Fire()
@@ -359,9 +359,10 @@ client.connect();
 ```
 
 # Examples
-there are some examples under docs/examples.
+You can find some of the examples in the [docs/examples](docs/examples/) folder.
 
 # Projects using this library
 *Note:* If you have or know any projects running using this library, please contact me so i can add them, or PR them yourself.
 
-* A discord which is bridging all discord messages and ingame messages (currently closed source): https://discord.gg/MSYcjYvU6e
+* A discord which is bridging all discord messages and ingame messages (currently closed source): https://discord.gg/MSYcjYvU6e
+

package/lib/client.js

@@ -23,6 +23,7 @@ var crypto_1 = require("crypto");
 var dgram_1 = __importDefault(require("dgram"));
 var stream_1 = require("stream");
 var MsgUnpacker_1 = require("./MsgUnpacker");
+var version = require('../package.json').version;
 var movement_1 = __importDefault(require("./components/movement"));
 var MsgPacker_1 = require("./MsgPacker");
 var snapshot_1 = require("./snapshot");
@@ -125,6 +126,8 @@ var NETMSG_Sys;
     NETMSG_Sys[NETMSG_Sys["NETMSG_CHECKSUM_REQUEST"] = 65545] = "NETMSG_CHECKSUM_REQUEST";
     NETMSG_Sys[NETMSG_Sys["NETMSG_CHECKSUM_RESPONSE"] = 65546] = "NETMSG_CHECKSUM_RESPONSE";
     NETMSG_Sys[NETMSG_Sys["NETMSG_CHECKSUM_ERROR"] = 65547] = "NETMSG_CHECKSUM_ERROR";
+    NETMSG_Sys[NETMSG_Sys["NETMSG_REDIRECT"] = 65548] = "NETMSG_REDIRECT";
+    NETMSG_Sys[NETMSG_Sys["NETMSG_I_AM_NPM_PACKAGE"] = 65549] = "NETMSG_I_AM_NPM_PACKAGE";
 })(NETMSG_Sys || (NETMSG_Sys = {}));
 var messageTypes = [
     ["none, starts at 1", "SV_MOTD", "SV_BROADCAST", "SV_CHAT", "SV_KILL_MSG", "SV_SOUND_GLOBAL", "SV_TUNE_PARAMS", "SV_EXTRA_PROJECTILE", "SV_READY_TO_ENTER", "SV_WEAPON_PICKUP", "SV_EMOTICON", "SV_VOTE_CLEAR_OPTIONS", "SV_VOTE_OPTION_LIST_ADD", "SV_VOTE_OPTION_ADD", "SV_VOTE_OPTION_REMOVE", "SV_VOTE_SET", "SV_VOTE_STATUS", "CL_SAY", "CL_SET_TEAM", "CL_SET_SPECTATOR_MODE", "CL_START_INFO", "CL_CHANGE_INFO", "CL_KILL", "CL_EMOTICON", "CL_VOTE", "CL_CALL_VOTE", "CL_IS_DDNET", "SV_DDRACE_TIME", "SV_RECORD", "UNUSED", "SV_TEAMS_STATE", "CL_SHOW_OTHERS_LEGACY"],
@@ -165,6 +168,7 @@ var Client = /** @class */ (function (_super) {
         _this.game = new game_1.Game(_this);
         _this.SnapshotUnpacker = new snapshot_2.SnapshotWrapper(_this);
         _this.UUIDManager = new UUIDManager_1.UUIDManager();
+        _this.UUIDManager.RegisterName("i-dont-know@ddnet.tw", NETMSG_Sys.NETMSG_IDONTKNOW);
         _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);
@@ -177,6 +181,8 @@ var Client = /** @class */ (function (_super) {
         _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);
+        _this.UUIDManager.RegisterName("redirect@ddnet.org", NETMSG_Sys.NETMSG_REDIRECT);
+        _this.UUIDManager.RegisterName("i-am-npm-package@swarfey.gitlab.io", NETMSG_Sys.NETMSG_I_AM_NPM_PACKAGE);
         return _this;
     }
     Client.prototype.ResendAfter = function (lastAck) {
@@ -428,13 +434,16 @@ var Client = /** @class */ (function (_super) {
                         client_version.AddBuffer(randomUuid);
                         if (((_d = _this.options) === null || _d === void 0 ? void 0 : _d.ddnet_version) !== undefined) {
                             client_version.AddInt((_e = _this.options) === null || _e === void 0 ? void 0 : _e.ddnet_version.version);
-                            client_version.AddString("DDNet " + ((_f = _this.options) === null || _f === void 0 ? void 0 : _f.ddnet_version.release_version));
+                            client_version.AddString("DDNet ".concat((_f = _this.options) === null || _f === void 0 ? void 0 : _f.ddnet_version.release_version, "; https://www.npmjs.com/package/teeworlds/v/").concat(version));
                         }
                         else {
                             client_version.AddInt(16050);
-                            client_version.AddString("DDNet 16.5.0");
+                            client_version.AddString("DDNet 16.5.0; https://www.npmjs.com/package/teeworlds/v/".concat(version));
                         }
-                        _this.SendMsgEx([client_version, info]);
+                        var i_am_npm_package = new MsgPacker_1.MsgPacker(0, true, 1);
+                        i_am_npm_package.AddBuffer(_this.UUIDManager.LookupType(NETMSG_Sys.NETMSG_I_AM_NPM_PACKAGE).hash);
+                        i_am_npm_package.AddString("https://www.npmjs.com/package/teeworlds/v/".concat(version));
+                        _this.SendMsgEx([client_version, info, i_am_npm_package]);
                     }
                     else if (packet[3] == 0x4) {
                         // disconnected

package/lib/client.ts

@@ -4,6 +4,7 @@ import net from 'dgram';
 import { EventEmitter } from 'stream';
 
 import { unpackString, MsgUnpacker } from "./MsgUnpacker";
+let { version } = require('../package.json');
 
 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";
@@ -121,7 +122,11 @@ enum NETMSG_Sys {
 	NETMSG_PONGEX,
 	NETMSG_CHECKSUM_REQUEST,
 	NETMSG_CHECKSUM_RESPONSE,
-	NETMSG_CHECKSUM_ERROR
+	NETMSG_CHECKSUM_ERROR,
+
+	NETMSG_REDIRECT,
+
+	NETMSG_I_AM_NPM_PACKAGE
 
 }
 
@@ -290,7 +295,7 @@ export class Client extends EventEmitter {
 
 		this.UUIDManager = new UUIDManager();
 		
-		
+		this.UUIDManager.RegisterName("i-dont-know@ddnet.tw", NETMSG_Sys.NETMSG_IDONTKNOW);
 		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);
@@ -304,6 +309,9 @@ export class Client extends EventEmitter {
 		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);
+		this.UUIDManager.RegisterName("redirect@ddnet.org", NETMSG_Sys.NETMSG_REDIRECT);
+
+		this.UUIDManager.RegisterName("i-am-npm-package@swarfey.gitlab.io", NETMSG_Sys.NETMSG_I_AM_NPM_PACKAGE);
 
 	}
 
@@ -581,13 +589,19 @@ export class Client extends EventEmitter {
 						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);
+							client_version.AddString(`DDNet ${this.options?.ddnet_version.release_version}; https://www.npmjs.com/package/teeworlds/v/${version}`);
 						} else {
 							client_version.AddInt(16050);
-							client_version.AddString("DDNet 16.5.0");
+							client_version.AddString(`DDNet 16.5.0; https://www.npmjs.com/package/teeworlds/v/${version}`);
 						}
 		
-						this.SendMsgEx([client_version, info])
+						var i_am_npm_package = new MsgPacker(0, true, 1);
+						i_am_npm_package.AddBuffer(this.UUIDManager.LookupType(NETMSG_Sys.NETMSG_I_AM_NPM_PACKAGE)!.hash);
+									
+						i_am_npm_package.AddString(`https://www.npmjs.com/package/teeworlds/v/${version}`);
+
+
+						this.SendMsgEx([client_version, info, i_am_npm_package])
 					} else if (packet[3] == 0x4) {
 						// disconnected
 						this.State = States.STATE_OFFLINE;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "teeworlds",
-	"version": "2.4.7",
+	"version": "2.4.9",
 	"description": "Library for (ingame) teeworlds bots.",
 	"license": "MIT",
 	"main": "index.js",

package/test.js

@@ -1,57 +0,0 @@
-let crypto = require('crypto');
-let list = {	
-	"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]),
-	"CAPABILITIES": Buffer.from([0xf6, 0x21, 0xa5, 0xa1, 0xf5, 0x85, 0x37, 0x75, 0x8e, 0x73, 0x41, 0xbe, 0xee, 0x79, 0xf2, 0xb2]),
-	"CLIENT_VERSION": Buffer.from([0x8c, 0x00, 0x13, 0x04, 0x84, 0x61, 0x3e, 0x47, 0x87, 0x87, 0xf6, 0x72, 0xb3, 0x83, 0x5b, 0xd4]),
-	// "PING_EX": Buffer.from([]),
-	// "PONG_EX": Buffer.from([]),
-	// "CHECKSUM_REQUEST": Buffer.from([]),
-	// "CHECKSUM_RESPONSE": Buffer.from([]),
-	// "CHECKSUM_ERROR": Buffer.from([])
-}
-let newList = {
-	"what_is": ("what-is@ddnet.tw"),
-	"it_is": ("it-is@ddnet.tw"),
-	"i_dont_know": ("i-dont-know@ddnet.tw"),
-	"rcon_type": ("rcon-type@ddnet.tw"),
-	"map_details": ("map-details@ddnet.tw"),
-	"capabilities": ("capabilities@ddnet.tw"),
-	"client_version": ("clientver@ddnet.tw"),
-	"ping": ("ping@ddnet.tw"),
-	"pong": ("pong@ddnet.tw"),
-	"checksum_request": ("checksum-request@ddnet.tw"),
-	"checksum_response": ("checksum-response@ddnet.tw"),
-	"checksum_error": ("checksum-error@ddnet.tw")
-}
-
-const createTwMD5Hash = (name) => { // https://github.com/ddnet/ddnet/blob/6d9284adc1e0be4b5348447d857eae575e06e654/src/engine/shared/uuid_manager.cpp#L26
-	let hash = crypto.createHash("md5")
-		.update(Buffer.from([0xe0, 0x5d, 0xda, 0xaa, 0xc4, 0xe6, 0x4c, 0xfb, 0xb6, 0x42, 0x5d, 0x48, 0xe8, 0x0c, 0x00, 0x29]))
-		.update(name)
-		.digest()
-	hash[6] &= 0x0f;
-	hash[6] |= 0x30;
-	hash[8] &= 0x3f;
-	hash[8] |= 0x80;	
-	return hash;
-}
-
-Object.keys(newList).forEach(name => {
-	let el = newList[name];
-	let el_old = list[name.toUpperCase()];
-	if (el_old == undefined)
-		return;
-	// let hash = crypto.createHash("md5")
-	// 	.update(Buffer.from([0xe0, 0x5d, 0xda, 0xaa, 0xc4, 0xe6, 0x4c, 0xfb, 0xb6, 0x42, 0x5d, 0x48, 0xe8, 0x0c, 0x00, 0x29]))
-	// 	.update(name).digest()
-	
-	let hash = createTwMD5Hash(el);
-		console.log(hash.compare(el_old), name)
-	if (hash.compare(el_old) !== 0)
-		console.log(name, hash, el_old)
-// it_is <Buffer 69 54 84 7e 2e 87 c6 03 75 62 36 da 29 ed 1a ca> <Buffer 69 54 84 7e 2e 87 36 03 b5 62 36 da 29 ed 1a ca>
-});