From 00f05b53857cd4e77ec6a1a56b8e72227135ec4f Mon Sep 17 00:00:00 2001 From: mmorrison Date: Sun, 3 Feb 2019 23:40:47 -0600 Subject: [PATCH] Add support for vcmp, 2.0.9, Fixes #106 --- README.md | 5 ++- games.txt | 2 +- protocols/samp.js | 68 ++++++++++++++++++++++--------- protocols/vcmp.js | 12 ++++++ reference/vcmp/lgsl.txt | 90 ----------------------------------------- 5 files changed, 65 insertions(+), 112 deletions(-) create mode 100644 protocols/vcmp.js delete mode 100644 reference/vcmp/lgsl.txt diff --git a/README.md b/README.md index aaa7df6..3218097 100644 --- a/README.md +++ b/README.md @@ -311,6 +311,7 @@ Games List * Unreal Tournament 3 (ut3) * Urban Terror (urbanterror) * V8 Supercar Challenge (v8supercar) +* Vice City Multiplayer (vcmp) * Ventrilo (ventrilo) * Vietcong (vietcong) * Vietcong 2 (vietcong2) @@ -349,7 +350,6 @@ Games List * Sum of All Fears * Teeworlds * Tribes 2 -* Vice City Multiplayer * World in Conflict > Want support for one of these games? Please open an issue to show your interest! @@ -429,6 +429,9 @@ as well: `--debug`, `--pretty`, `--socketTimeout 5000`, etc. Changelog --- +### 2.0.9 +Added support for Vice City: Multiplayer + ### 2.0.8 * Improve out-of-order packet handling for gamespy1 protocol * Work-around for buggy duplicate player reporting from bf1942 servers diff --git a/games.txt b/games.txt index faf75e7..e065e62 100644 --- a/games.txt +++ b/games.txt @@ -21,7 +21,6 @@ # teeworlds|Teeworlds|teeworlds|port=8303 # tribes|Tribes 1: Starsiege|tribes|port_query=28001 # tribes2|Tribes 2|tribes2|port_query=28000 -# vcmp|Vice City Multiplayer|vcmp # worldinconflict|World in Conflict|worldinconflict @@ -285,6 +284,7 @@ ut3|Unreal Tournament 3|ut3|port=7777,port_query_offset=-1277 urbanterror|Urban Terror|quake3|port_query=27960 v8supercar|V8 Supercar Challenge|gamespy1|port_query=16700 +vcmp|Vice City Multiplayer|vcmp|port=8192 ventrilo|Ventrilo|ventrilo|port=3784 vietcong|Vietcong|gamespy1|port=5425,port_query=15425 vietcong2|Vietcong 2|gamespy2|port=5001,port_query=19967 diff --git a/protocols/samp.js b/protocols/samp.js index 57cff96..4b3b70f 100644 --- a/protocols/samp.js +++ b/protocols/samp.js @@ -4,22 +4,30 @@ class Samp extends Core { constructor() { super(); this.encoding = 'win1252'; + this.magicHeader = 'SAMP'; + this.responseMagicHeader = null; + this.isVcmp = false; } async run(state) { // read info { const reader = await this.sendPacket('i'); + if (this.isVcmp) { + let version = reader.string(12); + version = version.replace(/\0.*$/g,''); + state.raw.version = version; + } state.password = !!reader.uint(1); state.raw.numplayers = reader.uint(2); state.maxplayers = reader.uint(2); state.name = this.readString(reader,4); state.raw.gamemode = this.readString(reader,4); - this.map = this.readString(reader,4); + state.raw.map = this.readString(reader,4); } // read rules - { + if (!this.isVcmp) { const reader = await this.sendPacket('r'); const ruleCount = reader.uint(2); state.raw.rules = {}; @@ -28,29 +36,44 @@ class Samp extends Core { const value = this.readString(reader,1); state.raw.rules[key] = value; } - if('mapname' in state.raw.rules) - state.map = state.raw.rules.mapname; } // read players - { - const reader = await this.sendPacket('d', true); - if (reader !== null) { - const playerCount = reader.uint(2); - for(let i = 0; i < playerCount; i++) { - const player = {}; - player.id = reader.uint(1); - player.name = this.readString(reader,1); - player.score = reader.int(4); - player.ping = reader.uint(4); - state.players.push(player); + // don't even bother if > 100 players, because the server won't respond + let gotPlayerData = false; + if (state.raw.numplayers < 100) { + if (this.isVcmp) { + const reader = await this.sendPacket('c', true); + if (reader !== null) { + gotPlayerData = true; + const playerCount = reader.uint(2); + for(let i = 0; i < playerCount; i++) { + const player = {}; + player.name = this.readString(reader,1); + state.players.push(player); + } } } else { - for(let i = 0; i < state.raw.numplayers; i++) { - state.players.push({}); + const reader = await this.sendPacket('d', true); + if (reader !== null) { + gotPlayerData = true; + const playerCount = reader.uint(2); + for(let i = 0; i < playerCount; i++) { + const player = {}; + player.id = reader.uint(1); + player.name = this.readString(reader,1); + player.score = reader.int(4); + player.ping = reader.uint(4); + state.players.push(player); + } } } } + if (!gotPlayerData) { + for(let i = 0; i < state.raw.numplayers; i++) { + state.players.push({}); + } + } } readString(reader,lenBytes) { const length = reader.uint(lenBytes); @@ -59,7 +82,7 @@ class Samp extends Core { } async sendPacket(type,allowTimeout) { const outBuffer = Buffer.alloc(11); - outBuffer.writeUInt32BE(0x53414D50,0); + outBuffer.write(this.magicHeader,0, 4); const ipSplit = this.options.address.split('.'); outBuffer.writeUInt8(parseInt(ipSplit[0]),4); outBuffer.writeUInt8(parseInt(ipSplit[1]),5); @@ -68,12 +91,17 @@ class Samp extends Core { outBuffer.writeUInt16LE(this.options.port,8); outBuffer.writeUInt8(type.charCodeAt(0),10); + const checkBuffer = Buffer.from(outBuffer); + if (this.responseMagicHeader) { + checkBuffer.write(this.responseMagicHeader, 0, 4); + } + return await this.udpSend( outBuffer, (buffer) => { const reader = this.reader(buffer); - for(let i = 0; i < outBuffer.length; i++) { - if(outBuffer.readUInt8(i) !== reader.uint(1)) return; + for(let i = 0; i < checkBuffer.length; i++) { + if(checkBuffer.readUInt8(i) !== reader.uint(1)) return; } return reader; }, diff --git a/protocols/vcmp.js b/protocols/vcmp.js new file mode 100644 index 0000000..8f64fa2 --- /dev/null +++ b/protocols/vcmp.js @@ -0,0 +1,12 @@ +const Samp = require('./samp'); + +class Vcmp extends Samp { + constructor() { + super(); + this.magicHeader = 'VCMP'; + this.responseMagicHeader = 'MP04'; + this.isVcmp = true; + } +} + +module.exports = Vcmp; diff --git a/reference/vcmp/lgsl.txt b/reference/vcmp/lgsl.txt deleted file mode 100644 index a5f5b7e..0000000 --- a/reference/vcmp/lgsl.txt +++ /dev/null @@ -1,90 +0,0 @@ - - /*----------------------------------------------------------------------------------------------------------\ - | | - | [ LIVE GAME SERVER LIST ] [ © RICHARD PERRY FROM GREYCUBE.COM ] | - | | - | Released under the terms and conditions of the GNU General Public License Version 3 (http://gnu.org) | - | | - \-----------------------------------------------------------------------------------------------------------*/ - - function lgsl_query_12(&$server, &$lgsl_need, &$lgsl_fp) - { -//---------------------------------------------------------+ -// REFERENCE: -// VICE CITY CURRENTLY ONLY SUPPORTS THE 'i' CHALLENGE - - if ($server['b']['type'] == "samp") { $challenge_packet = "SAMP\x21\x21\x21\x21\x00\x00"; } - elseif ($server['b']['type'] == "vcmp") { $challenge_packet = "VCMP\x21\x21\x21\x21\x00\x00"; $lgsl_need['e'] = FALSE; $lgsl_need['p'] = FALSE; } - - if ($lgsl_need['s']) { $challenge_packet .= "i"; } - elseif ($lgsl_need['e']) { $challenge_packet .= "r"; } - elseif ($lgsl_need['p']) { $challenge_packet .= "d"; } - - fwrite($lgsl_fp, $challenge_packet); - - $buffer = fread($lgsl_fp, 4096); - - if (!$buffer) { return FALSE; } - -//---------------------------------------------------------+ - - $buffer = substr($buffer, 10); // REMOVE HEADER - - $response_type = lgsl_cut_byte($buffer, 1); - -//---------------------------------------------------------+ - - if ($response_type == "i") - { - $lgsl_need['s'] = FALSE; - - $server['s']['password'] = ord(lgsl_cut_byte($buffer, 1)); - $server['s']['players'] = lgsl_unpack(lgsl_cut_byte($buffer, 2), "S"); - $server['s']['playersmax'] = lgsl_unpack(lgsl_cut_byte($buffer, 2), "S"); - $server['s']['name'] = lgsl_cut_pascal($buffer, 4); - $server['e']['gamemode'] = lgsl_cut_pascal($buffer, 4); - $server['s']['map'] = lgsl_cut_pascal($buffer, 4); - } - -//---------------------------------------------------------+ - - elseif ($response_type == "r") - { - $lgsl_need['e'] = FALSE; - - $item_total = lgsl_unpack(lgsl_cut_byte($buffer, 2), "S"); - - for ($i=0; $i<$item_total; $i++) - { - if (!$buffer) { return FALSE; } - - $data_key = strtolower(lgsl_cut_pascal($buffer)); - $data_value = lgsl_cut_pascal($buffer); - - $server['e'][$data_key] = $data_value; - } - } - -//---------------------------------------------------------+ - - elseif ($response_type == "d") - { - $lgsl_need['p'] = FALSE; - - $player_total = lgsl_unpack(lgsl_cut_byte($buffer, 2), "S"); - - for ($i=0; $i<$player_total; $i++) - { - if (!$buffer) { return FALSE; } - - $server['p'][$i]['pid'] = ord(lgsl_cut_byte($buffer, 1)); - $server['p'][$i]['name'] = lgsl_cut_pascal($buffer); - $server['p'][$i]['score'] = lgsl_unpack(lgsl_cut_byte($buffer, 4), "S"); - $server['p'][$i]['ping'] = lgsl_unpack(lgsl_cut_byte($buffer, 4), "S"); - } - } - -//---------------------------------------------------------+ - - return TRUE; - }