Added support for Group CHAT (WIP)

Author: roughnecks

README.md

@@ -6,11 +6,11 @@
 * development: new code which will hopefully end up in master.
 * nodb: this bot instance doesn't use Mongo DB so it doesn't do price checking for lotteries.
 * donation-only: this bot instance only accepts all donations and all kind of offers from bot's owner (doesn't use Mongo DB and doesn't do lotteries).
-* donation-only-without-2FA: this bot instance only accepts donations (no item loss) and doesn't use Mobile AUth (doesn't use Mongo DB and doesn't do lotteries).
+* donation-only-without-2FA: this bot instance only accepts donations (no item loss) and doesn't use Mobile Auth (doesn't use Mongo DB and doesn't do lotteries).
 
 ***
 
-**_Steam Trading BoT | Handles Trade Offers and Friends Invites_**
+**_Steam Trading/CHAT BoT | Handles Trade Offers, Friends Invites and Group CHATs_**
 
 The following is a list of functions that ZED provides at the moment:
 
@@ -23,6 +23,7 @@ The following is a list of functions that ZED provides at the moment:
 * Chat messages check (logs to console when bot receives a chat message).
 * Notifications check (logs to console if any new comment is available).
 * Lottery: Send any 1 Trading Card, Background, Emoticon or Booster Pack to the BoT and it will send you back a random Item of the same type (card for card, emote for emote etc...).
+* Group CHAT: Join the BoT to any Group CHAT manually or via config file and start using commands (WIP).
 
 
 ## Required software
@@ -36,6 +37,7 @@ The following is a list of functions that ZED provides at the moment:
 * chalk
 * console-stamp
 * mongodb
+* request
 * steam-totp
 * steam-tradeoffer-manager
 * steam-user
@@ -51,7 +53,7 @@ Run `npm install` inside BoT's directory to install all dependencies.
 
 `password`: bot's Steam Account Password
 
-`sharedSecret`: You might be wondering where to find the shared/identity secret and there are actually many tutorials depending on your device [1]
+`sharedSecret`: You might be wondering where to find the shared/identity secret and there are actually many tutorials depending on your device. [1]
 
 `identitySecret`: Same as above.
 
@@ -63,6 +65,8 @@ Run `npm install` inside BoT's directory to install all dependencies.
 
 `botSteamID3`: See Above
 
+`ClanChatGroupID`: Your Group's ID64 to have the BoT automatically join it. [2]
+
 `customGame`: This is Non-Steam Game Played by the BoT - Something like "Trash BoT - Accepting Junk" or whatever you want.
 
 `lockedItems`: This is an array of Items you don't want to be traded by the BoT (maybe you're using them in your profile, like a background).
@@ -73,11 +77,16 @@ Run `npm install` inside BoT's directory to install all dependencies.
 
 `syncInventoryWithDbOnStartup`: Update DB entries syncing them with bot's Inventory (you can also sync manually with Admin-Only "!sync" command).
 
-`db "connectionString"`: This depends on your MongoDB Configuration - Something like this should work: "mongodb://localhost:27017/zed"
+`openweathermapAPI`: Not mandatory but "!weather" command won't work without it. If you want to get one for free, visit: "https://openweathermap.org/api".
+
+`steamAPI`: Not mandatory but "!tf2" command won't work without it. You can get yours for free by visiting "https://steamcommunity.com/dev/apikey".
+
+`db "connectionString"`: This depends on your MongoDB Configuration - Something like this should work: "mongodb://localhost:27017/zed".
 
 
 [1] Shared/Identity secrets must be extracted from your Two Factor Authenticator App, so it's always a different process depending on which device
 you're actually using: iPhone - Android - 3rd Party Desktop App like WinAuth etc...
+[2] You can check steamID of your group by navigating to its page, then adding /memberslistxml?xml=1 to the end of the link, so the link will look like this: "https://steamcommunity.com/groups/wrongditch/memberslistxml?xml=1". Then you can get steamID of your group from the result, it's in <groupID64> tag.
 
 ## Starting the BoT
 
@@ -91,4 +100,13 @@ you're actually using: iPhone - Android - 3rd Party Desktop App like WinAuth etc
 
 ### Admin-Only
 
-`!sync`: Sync DB and Inventory Items manually.
+`!sync`: Sync DB and Inventory Items manually.
+
+## Group CHAT Commands
+
+`!help` || `!commands`: You'll get a list of all commands.
+
+### Featured Commands
+
+`!weather <city> <unit of measure>`: Query "openweathermaps" to get weather info for chosen city in Metric or Imperial units.
+`!tf2 <class>`: Get personal Team Fortress 2 Stats for chosen class.

app/client.js

@@ -4,8 +4,8 @@ const zed = require('./main');
 const config = require('../config.json');
 const SteamUser = require('steam-user');
 
-//console colors
 const chalk = require('chalk');
+const request = require('request');
 
 zed.manager._steam.on('loggedOn', function (details) {
     if (details.eresult === SteamUser.EResult.OK) {
@@ -26,6 +26,25 @@ zed.manager._steam.on('loggedOn', function (details) {
         });
         zed.manager._steam.setPersona(5); //"5": "LookingToTrade" -- https://github.com/DoctorMcKay/node-steam-user/blob/master/enums/EPersonaState.js
         zed.manager._steam.gamesPlayed(zed.config.customGame);
+
+
+        //Join GROUP CHAT
+        if (zed.config.ClanChatGroup) {
+            zed.manager._steam.chat.getClanChatGroupInfo(zed.config.ClanChatGroup, function (err, response) {
+                if (!err) {
+                    //console.log(response);
+                    zed.manager._steam.chat.joinGroup(response.chat_group_summary.chat_group_id, function (err, response) {
+                        if (err) {
+                            console.log(err);
+                        }
+                    });
+                } else {
+                    console.log(err);
+                }
+            });
+        }
+
+
     } else {
         console.log(details);
         //Do whatever u want to handle the error...
@@ -132,6 +151,29 @@ zed.manager._steam.on('friendRelationship', (steamID, relationship) => {
     }
 });
 
+
+
+//New Group Chat Message
+//This will fire when a new chat message gets posted in Group Chat we're in
+zed.manager._steam.chat.on('chatMessage', function (message) {
+    var senderID = message.steamid_sender;
+    var senderAccountID = senderID.accountid;
+    
+    //console.log(message);
+
+    zed.manager._steam.getPersonas([senderID], function (err, personas) {
+        if (!err) {
+            var sender = personas[senderID]["player_name"];
+            parseMessage(message.chat_group_id, message.chat_id, message.message_no_bbcode, senderID, senderAccountID, sender);
+        } else {
+            console.log(err);
+        }
+    });
+
+});
+
+
+
 //Commands
 zed.manager._steam.on('friendMessage', function (steamID, message) {
     if (message.startsWith('[tradeoffer sender=')) {
@@ -164,4 +206,291 @@ zed.manager._steam.on('friendMessage', function (steamID, message) {
     else {
         zed.manager._steam.chatMessage(steamID, 'I don\'t understand any other command but "!help", "!sign" and "!lottery" (so far).');
     }
-});
+});
+
+
+async function parseMessage(groupID, chatID, message, senderID, senderAccountID, sender) {
+    if (!message || !message.startsWith('!')) {
+        return;
+    }
+
+    /*
+    if (server_message && server_message.message == 2) {
+        zed.manager._steam.getPersonas([server_message.steamid_param], function (err, personas) {
+            if (!err) {
+                var joined = personas[server_message.steamid_param]["player_name"];
+                zed.manager._steam.chat.sendChatMessage(groupID, chatID, "Welcome aboard " + "[mention=" + server_message.steamid_param.accountid + "]@" + joined + "[/mention]" + "!" + " :steamhappy:");
+            } else {
+                console.log(err);
+                return;
+            }
+        });
+    }
+    */
+
+    if (message === "!hello") {
+        zed.manager._steam.chat.sendChatMessage(groupID, chatID, "Hi there " + "[mention=" + senderAccountID + "]@" + sender + "[/mention]" + "!" + " :steamhappy:");  // [mention=accountid]@name[/mention]
+    } else if (message === "!next") {
+        zed.manager._steam.chat.sendChatMessage(groupID, chatID, "Your satisfaction is our best prize. Next!");
+    } else if (message === "!help") {
+        zed.manager._steam.chat.sendChatMessage(groupID, chatID, "I'm a trading and chat bot; if you want to trade with me, first read the info showcase on my profile. For a list of available commands, type '!commands' without the quotes. More at: https://github.com/roughnecks/ZED" );
+    } else if (message === "!commands") {
+        zed.manager._steam.chat.sendChatMessage(groupID, chatID, "!commands - !hello - !help - !next - !weather <city> <metric || imperial> - !tf2 <class>");
+    } else if (message.startsWith('!weather')) {
+        var str = message.substr(9);
+        var res = str.split(" ");
+
+        if (res.length > 1) {
+            var units = res[res.length - 1];
+            units = units.toUpperCase();
+            res.length = res.length - 1;
+            var city = res.join(' ');
+            checkWeather(city, units, groupID, chatID);
+        } else { zed.manager._steam.chat.sendChatMessage(groupID, chatID, "You must specify a city and a unit of measure, either 'metric' or 'imperial'."); }
+    
+    
+    } else if (message.startsWith('!tf2')) {
+        var tf2class = message.substr(5);
+        if (tf2class) {
+            tf2Stats(tf2class, groupID, chatID, sender, senderID);
+        } else { zed.manager._steam.chat.sendChatMessage(groupID, chatID, "You must specify a class."); }
+    }
+}
+
+
+async function checkWeather(city, units, groupID, chatID) {
+
+    var url;
+    var apiKey = zed.config.weatherAPI;
+
+    if (apiKey) {
+        if (units === 'METRIC') {
+            url = `http://api.openweathermap.org/data/2.5/weather?q=${city}&units=${units}&appid=${apiKey}`;
+        } else if (units === 'IMPERIAL') {
+            url = `http://api.openweathermap.org/data/2.5/weather?q=${city}&units=${units}&appid=${apiKey}`;
+        }
+        else {
+            zed.manager._steam.chat.sendChatMessage(groupID, chatID, "Wrong or missing unit of measure.");
+            return;
+        }
+
+        request(url, function (err, response, body) {
+            if (err) {
+                console.log('error:', error);
+            } else {
+                let weather = JSON.parse(body);
+                if (weather.cod == 404) {
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, "City not found.");
+                    return;
+                } else if (weather.cod == 200) {
+                    if (units === 'METRIC') {
+                        let result = `It's ${weather.weather[0].description} and ${weather.main.temp} °C in ${weather.name}, ${weather.sys.country}! Pressure is ${weather.main.pressure} hPa, humidity is ${weather.main.humidity}% and wind speed is ${weather.wind.speed} meter/sec.`;
+                        zed.manager._steam.chat.sendChatMessage(groupID, chatID, result);
+                    } else if (units == 'IMPERIAL') {
+                        let result = `It's ${weather.weather[0].description} and ${weather.main.temp} °F in ${weather.name}, ${weather.sys.country}! Pressure is ${weather.main.pressure} hPa, humidity is ${weather.main.humidity}% and wind speed is ${weather.wind.speed} miles/hour.`;
+                        zed.manager._steam.chat.sendChatMessage(groupID, chatID, result);
+                    }
+                }
+                else {
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, "Houston, we have a problem!");
+                    console.log(weather);
+                }
+            }
+        });
+    } else {
+        zed.manager._steam.chat.sendChatMessage(groupID, chatID, "No API Key defined in config file, aborting.")
+        return;
+    }
+}
+
+
+async function tf2Stats(tf2class, groupID, chatID, sender, senderID) {
+    var apikey = zed.config.steamAPI;
+
+    if (apikey) {
+        var playerID64 = senderID.getSteamID64();
+        var player = sender;
+        var tf2classLower = tf2class.toLowerCase();
+        var tf2classCapitalized = tf2classLower.charAt(0).toUpperCase() + tf2classLower.slice(1);
+        
+        var url = `http://api.steampowered.com/ISteamUserStats/GetUserStatsForGame/v0002/?appid=440&key=${apikey}&steamid=${playerID64}`;
+
+        request(url, function (error, response, body) {
+            if (error) {
+                console.log('error: '+ error);
+            } else {
+                //console.log(response.statusCode);
+
+                if (response.statusCode == 500) {
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, "Your Game Details are not Public.");
+                    return;
+                } else if (response.statusCode == 200) {
+                    let output = JSON.parse(body);
+                    //console.log(JSON.stringify(output))
+
+                    var accumBuild, maxBuild, accumDam, maxDam, accumDom, maxDom, accumKAss, maxKAss, accumKills, maxKills, accHours, maxMins, maxSecs, accumCap, maxCap, accumDef, maxDef, accumPoints, maxPoints, accumRev, maxRev, accumBack, maxBack, accumLeach, maxLeach, accumBuilt, maxBuilt, accumTel, maxTel, maxSentry, accumHeadS, maxHeadS, accumHeal, maxHeal, accumInvul, maxInvul;
+                    accumBuild = maxBuild = accumDam = maxDam = accumDom = maxDom = accumKAss = maxKAss = accumKills = maxKills = accHours = maxMins = maxSecs = accumCap = maxCap = accumDef = maxDef = accumPoints = maxPoints = accumRev = maxRev = accumBack = maxBack = accumLeach = maxLeach = accumBuilt = maxBuilt = accumTel = maxTel = maxSentry = accumHeadS = maxHeadS = accumHeal = maxHeal = accumInvul = maxInvul = "-";
+
+                    var stats = output.playerstats.stats;
+                    for (var i = 0; i < stats.length; i++) {
+                        if (stats[i].name == tf2classCapitalized + ".accum.iBuildingsDestroyed") {
+                            accumBuild = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iBuildingsDestroyed") {
+                            maxBuild = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iDamageDealt") {
+                            accumDam = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iDamageDealt") {
+                            maxDam = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iDominations") {
+                            accumDom = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iDominations") {
+                            maxDom = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iKillAssists") {
+                            accumKAss = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iKillAssists") {
+                            maxKAss = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iNumberOfKills") {
+                            accumKills = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iNumberOfKills") {
+                            maxKills = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iPlayTime") {
+                            var accumTime = stats[i].value;
+                            accHours = Math.round(accumTime * 100 / 3600) / 100;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iPlayTime") {
+                            var maxTime = stats[i].value;
+                            maxMins = Math.floor(maxTime / 60);
+                            maxSecs = maxTime - maxMins * 60;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iPointCaptures") {
+                            accumCap = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iPointCaptures") {
+                            maxCap = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iPointDefenses") {
+                            accumDef = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iPointDefenses") {
+                            maxDef = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iPointsScored") {
+                            accumPoints = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iPointsScored") {
+                            maxPoints = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iRevenge") {
+                            accumRev = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iRevenge") {
+                            maxRev = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iBackstabs") {
+                            accumBack = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iBackstabs") {
+                            maxBack = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iHealthPointsLeached") {
+                            accumLeach = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iHealthPointsLeached") {
+                            maxLeach = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iBuildingsBuilt") {
+                            accumBuilt = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iBuildingsBuilt") {
+                            maxBuilt = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iNumTeleports") {
+                            accumTel = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iNumTeleports") {
+                            maxTel = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iSentryKills") {
+                            maxSentry = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iHeadshots") {
+                            accumHeadS = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iHeadshots") {
+                            maxHeadS = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iHealthPointsHealed") {
+                            accumHeal = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iHealthPointsHealed") {
+                            maxHeal = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".accum.iNumInvulnerable") {
+                            accumInvul = stats[i].value;
+                        }
+                        else if (stats[i].name == tf2classCapitalized + ".max.iNumInvulnerable") {
+                            maxInvul = stats[i].value;
+                        }
+                    }
+                } else {
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, "Unknown Error");
+                    console.log('Response Status Code = ' + response.statusCode);
+                    console.log('Body = ' + body);
+                    return;
+                }
+
+                let result = ":sticky:" + `${tf2classCapitalized} Stats for Player "${player}":` + "\n" + "\n" 
+                + "Total Playtime / Longest Life: " + `${accHours}hrs` + " / " + `${maxMins}:${maxSecs}mins` + "\n"
+                + "Total / Most Points: " + accumPoints + " / " + maxPoints + "\n"
+                + "Total / Most Kills: " + accumKills + " / " + maxKills + "\n"
+                + "Total / Most Damage Dealt: " + accumDam + " / " + maxDam + "\n"
+                + "Total / Most Kill Assists: " + accumKAss + " / " + maxKAss + "\n"
+                + "Total / Most Dominations: " + accumDom + " / " + maxDom + "\n"
+                + "Total / Most Revenges: " + accumRev + " / " + maxRev + "\n"
+                + "Total / Most Buildings Destroyed: " + accumBuild + " / " + maxBuild + "\n"
+                + "Total / Most Captures: " + accumCap + " / " + maxCap + "\n"
+                + "Total / Most Defenses: " + accumDef + " / " + maxDef;
+                
+                
+                if ((tf2classCapitalized === 'Demoman') || (tf2classCapitalized === 'Soldier') || (tf2classCapitalized === 'Pyro') || (tf2classCapitalized === 'Heavy') || (tf2classCapitalized === 'Scout')) {
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, result);
+                } else if (tf2classCapitalized === 'Medic') {
+                    let medicResult = result + "\n" 
+                    + "Total / Most Points Healed: " + accumHeal + " / " + maxHeal + "\n" 
+                    + "Total / Most ÜberCharges: " + accumInvul + " / " + maxInvul;
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, medicResult);
+                } else if (tf2classCapitalized === 'Engineer') {
+                    let engiResult = result + "\n" 
+                    + "Total / Most Buildings Built: " + accumBuilt + " / " + maxBuilt + "\n" 
+                    + "Total / Most Teleports: " + accumTel + " / " + maxTel + "\n" 
+                    + "Most Kills By Sentry: " + maxSentry;
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, engiResult);
+                } else if (tf2classCapitalized === 'Spy') {
+                    let spyResult = result + "\n" 
+                    + "Total / Most Backstabs: " + accumBack + " / " + maxBack + "\n" 
+                    + "Total / Most Health Points Leached: " + accumLeach + " / " + maxLeach;
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, spyResult);
+                } else if (tf2classCapitalized === 'Sniper') {
+                    let snipResult = result + "\n" 
+                    + "Total / Most Headshots: " + accumHeadS + " / " + maxHeadS;
+                    zed.manager._steam.chat.sendChatMessage(groupID, chatID, snipResult);
+                }
+                else {zed.manager._steam.chat.sendChatMessage(groupID, chatID, "Invalid class, moron!")};
+            }
+        });
+    } else {
+        zed.manager._steam.chat.sendChatMessage(groupID, chatID, "No API Key defined in config file, aborting.")
+        return;
+    }
+}
+

app/main.js

@@ -18,10 +18,12 @@ const zed = {
         ownerSteamID3: config.ownerSteamID3,
         botSteamID64: config.botSteamID64,
         botSteamID3: config.botSteamID3,
+        ClanChatGroup: config.ClanChatGroupID,
         customGame: config.customGame,
-        pin: config.familyViewPin,        
-        //Items that bot owns and are not up for trading
+        pin: config.familyViewPin,
         lockedItems: config.lockedItems,
+        weatherAPI: config.openweathermapAPI,
+        steamAPI: config.steamAPI,
         logOnOptions: {
             accountName: config.username,
             password: config.password,

config.json

@@ -7,11 +7,14 @@
   "ownerSteamID3": "",
   "botSteamID64": "",
   "botSteamID3": "",
+  "ClanChatGroupID": "",
   "customGame": "",
   "lockedItems": [],
   "familyViewPin": "",
   "updatePricesOnStartup": false,
   "syncInventoryWithDbOnStartup": true,
+  "openweathermapAPI": "",
+  "steamAPI": "",
   "db": {
     "connectionString": ""
   }