@baris thanks very much for this. I'll test it now
Edit - from what I can see, everything now works as expected. Thanks
It is with great pleasure that i announce the release of version 3.0.0 of sockbot featuring support for NodeBB forums.
Sockbot is a userbot that logs in as a standard user and performs actions based on that users behalf. Interactions with the bot can then be achieved via posting messages to the bot.
Sockbot 3.0 includes two plugins by default
summoner, The SockDevs will be releasing more plugins in the future and any interested party is welcome to write their own. We will be providing detailed how-tos regarding writing all sorts of plugins in the near future.
In order to run Sockbot you will need at least version 4.0 of nodejs. Version 5.0 or greater is recommended
Sockbot is developed and tested on Linux, however it should work just fine on Windows and OSX as well.
It is recommended to install Sockbot globally via NPM if you have sufficient access. This adds the binary to your command line environment for convenient access.
Execute the NPM command below to install Sockbot globally.
$ npm install -g sockbot
Once sockbot is installed you will need a configuration file to set up necessary settings. Here's one i've prepared earlier that utilizes the
summoner module to implement a bot that quotes Zoidberg when mentioned:
--- - core: username: "Zoidberg" password: "ZoidbergsPasswordZoidbergsPassword" owner: "accalia" forum: "http://nodebb.example.com" plugins: summoner: messages: - "@%username%, You seem malnourished. Are you suffering from internal parasites?" - "@%username%. I challenge you to \"clawplach\"!" - "I wonder what the Shroud of Turin tastes like." - "Yeah, but did you ever play Jenga? Sometimes you take out one and... [imitates crashing]" - "It's good cholesterol, but it spreads like bad cholesterol." - "Zoidberg is afoot!" - "On margin. Zoidbee wants to buy on margin." - "Zoidbie want balloon! Want balloon now! Zoidbie want go outside!" - "Tired of Discourse? Why not @Zoidberg?" - "I took the liberty of fertilizing your caviar." - "I've had it with this game. I'm going for a scuttle." - "Doctor Zoidberg, soaking in brine." - "You lost the @%username% of your dreams, but you still have Zoidberg. YOU ALL STILL HAVE ZOIDBERG!" - "Sit down @%username%. Now open your mouth and lets have a look at that brain. " - "Young lady, I am an expert on humans. Now pick a mouth, open it and say \"brglgrglgrrr\"! " - "Hooray! People are paying attention to me!" - "I've performed a few mercy killings." - "It's been years since medical school, so remind me. Disemboweling in your species, fatal or non-fatal?" - "The frenzy is over. How am I going to get rid of my male jelly now?" - "Welcome to my life! :starts crying:" - "I don't like the looks of this doctor. I bet I've lost more patients than he's treated." - "What? My mother was a saint! Get out!" - "It's funny because it's poisonous!" - "Fine, then I'll have one of your young on a roll." - "Fine, just give me something crawling with parasites." - "And I'm his friend, Jesus!" - "Hooray! I'm a teenage heartthrob again!" - "There's a humongous fungus among us." - "I ate garbage yesterday, and it didn't cost me 300 dollars." - "Hey, boys and girls. It's Zoidberg, the loveable tramp." - "Hooray! A happy ending for the rich people." - "Switch bodies? I don't see why not. I also don't see why." - "The hell with your spoiled baby. I need those shoes." - "@%username%, look what you did! She won't shut up." - "Friends! Help! A guinea pig tricked me!!" - "Is it me maybe?" - "Once again, the conservative, sandwich-heavy portfolio pays off for the hungry investor." - "Ohhh, it's all so complicated, with the flowers, and the romance, and the lies upon lies." - "What's this? Two meals in one week?" - "Friends! Help! A @%username% tricked me!" - "Oh, no! Something's happening! What's happening?" - "Are you coming on to me?" - "At last, recognition!" - "Hello? I'll take eight!" - "Hooray! I'm helping!"
Configuration files may be in JSON or YAML format.
Once you have a configuration file you can start Sockbot by executing the
sockbot command with the path to the configuration file as a parameter as seen below.
$ sockbot path/to/config.yml
This will start the bot, once the bot has logged in you can go to your forum and mention the bot account to get a random Zoidberg quote!
Up to date installation instructions can be found in the docs, including alternate installation setups.
Sockbot also understands a command format such that can be issued to the bot. All issued commands are registered so that they will be reported by the
help command. Sockbot processes commands from any post that generates a notification to the bot and understands two different formats.
echo plugin contains an example of using commands in a plugin. The
echo plugin adds an
echo command to the bot that when triggered replies to the post with a quote of the original post text.
Mention commands prefix a mention of the bot to the command name. The mention must be the first non markup element on a line, and must not be in a code block or quote.
The format for a mention command makes it convenient to issue a command to the bot in such a way that it is guaranteed to generate a notification.
For example. To execute the
florblewitz command with arguments
arguments you would post:
@sockbot florblewitz with arguments
Imperative commands prefix an exclamation mark to the command name. The command must be the first non markup element on a line, and must not be in a code block or quote.
The format for an imperative command makes it convenient for issuing multiple commands per post where the bot will already receive a notification for the post
For example. To execute the
florblewitz command with arguments
arguments you would post:
!florblewitz with arguments
Wow, this is fantastic
Glad to get such a full featured bot for NodeBB! @Schamper sounds like Botler's out of a job
Glad to get such a full featured bot for NodeBB
We still haven't added support for chats and with
summoner to provide "witty" commentary as the only official plugin so far (
echo is really just a testing plugin) we're still pretty bare for actual utilized functionality.
that being said....
what kind of functionality would you like to see added?
@julian good, now I finally won't feel pressured to actually finish it
@Schamper but-but-but competition is good for a free market!
what if the people are not free to choose which bot they wish to use for their botting porpoises? what will happen to the market then?
Lacking competitive market forces will it not stagnate and rot, to the detriment of all?
this is a PRE-RELEASE version and as such may have new and undiscovered bugs.
Fixes several bugs in v3.0.0 including (but not limited to)
Noteable updates in this merge:
@accalia took a certain fox long enough but....
So you have a bot and want to use it? why not use it to help moderate a game of Mafia?
Yamikuronue and Dreikin of sockbot's home forums have put together a plugin that helps moderate mafia games.
what is a mafia game? Well what.thedailywtf.com is starting one in the next couple of days, drop on by and take a gander!
All player commands must be run in the thread the game is being played in, as they are a matter of public record.
What happened to 1.0?
It's on Github, but we never released it to NPM
How do I install this?
Now that we're on NPM, the easiest way to get a bot running is with the following simple steps:
npm install -g sockbot
npm install -g sockmafia
config.ymlfile using the below template:
--- core: username: mafiabot password: mafiapassword owner: ownerAccount forum: http://nodebb.example.com/ plugins: sockmafia: thread: 52778 mods: - mod players: - player1 - player2 db: './mafiadb' name: testMafia voteBars: bastard
openfor visible vote totals;
hiddenfor no leaking.)
Hey, I can not get sockbot to work with summoner. Can anything post an exemple config file that works. Please :s
@UncleSam the example config i posted in the opening post should get you a bot that runs the summoner plugin using Zoidberg quotes.
Do you get any output on the console when you run your configuration? can you please post the output you have, either here or in a private chat with me?
i get this output, but nothing more hapens.
[2016-06-01T13:18:16.637Z] Starting Sockbot 3.1.0 - Beta Badger
[2016-06-01T13:18:16.653Z] Loaded configuration file: example.config.yml
[2016-06-01T13:18:16.654Z] Activating logon: DumDum
[2016-06-01T13:18:16.859Z] Using provider nodebb for DumDum
[2016-06-01T13:18:16.863Z] Loading plugin summoner for DumDum
[2016-06-01T13:18:16.865Z] DumDum ready for login
[2016-06-01T13:18:18.155Z] DumDum login successful
[2016-06-01T13:18:43.193Z] Ping exchanged with 1ms latency
[2016-06-01T13:19:08.200Z] Ping exchanged with 0ms latency
[2016-06-01T13:19:33.208Z] Ping exchanged with 1ms latency
[2016-06-01T13:19:58.230Z] Ping exchanged with 1ms latency
[2016-06-01T13:20:23.235Z] Ping exchanged with 1ms latency
@UncleSam that looks like a good login output to me.
what happens when you @mention the bot account on the forum to trigger the summon?
if that still fails try sending the following to the bot in a chat:
does the bot reply to that chat with anything?
if not please try starting the bot in debug mode and capturing the output from that by executing:
$> DEBUG=sockbot* sockbot path/to/config.yml
Nah nothing happens when i try @mention and !help
in debug mode i get this
[2016-06-01T18:20:16.337Z] Starting Sockbot 3.1.0 - Beta Badger
[2016-06-01T18:20:16.354Z] Loaded configuration file: example.config.yml
[2016-06-01T18:20:16.354Z] Activating logon: DumDum
sockbot requiring providers nodebb as /usr/lib/node_modules/sockbot/lib/../providers/nodebb +0ms
[2016-06-01T18:20:16.559Z] Using provider nodebb for DumDum
[2016-06-01T18:20:16.563Z] Loading plugin summoner for DumDum
sockbot requiring plugins summoner as /usr/lib/node_modules/sockbot/lib/../plugins/summoner +208ms
[2016-06-01T18:20:16.567Z] DumDum ready for login
sockbot:provider:nodebb begin configuration fetch for CSRF token +4ms
sockbot:provider:nodebb completed configuration fetch for CSRF token +47ms
sockbot:provider:nodebb begin post login data +0ms
sockbot:provider:nodebb complete post login data +1s
[2016-06-01T18:20:17.885Z] DumDum login successful
sockbot:provider:nodebb:user retrieving user by login DumDum +94ms
sockbot:provider:nodebb:user retrieving user by login accalia +6ms
[2016-06-01T18:20:42.963Z] Ping exchanged with 2ms latency
[2016-06-01T18:21:07.970Z] Ping exchanged with 1ms latency
[2016-06-01T18:21:32.993Z] Ping exchanged with 1ms latency
[2016-06-01T18:21:57.999Z] Ping exchanged with 0ms latency
[2016-06-01T18:22:23.016Z] Ping exchanged with 0ms latency
[2016-06-01T18:22:48.026Z] Ping exchanged with 1ms latency
@UncleSam that's........ strange.....
if you manually log into the bot account and view its profile page can you see any existing login sessions under the settings page.
they should show up as
unknown on Linux or
unknown on Windows depending on what OS the bot is running on (looks like Linux from your logs)
Yes it shows up as unknown on Linux
@UncleSam huh. and did the bot actually receive notifications from the forum in the time period it was online?
if so.... i'm very confused.... but never fear i will figure this out. there's one more piece of debugging available to me!
could you enable Ultra Debug Mode<sup>TM</sup> and send me a link via chat to a pastebin or gist of the file it generates?
There is a possibility of sensitive information being revealed through Ultra Debug Mode<sup>TM</sup> so please make sure the pastebin or gist is private and send the link to me over chat, rather than posting on the forum.
to enable Ultra Debug Mode<sup>TM</sup> run the bot with the following command:
$> DEBUG=* sockbot /path/to/config.yml 2>&1 | tee logfile.txt
then run the bot through it's paces by mentioning it and sending the help command via chat to the bot before sending me
That should provide me with all the necessary information to determine what's gone wrong.
Thank you for your patience and understanding in this matter.
@UncleSam please install the new version and test. it should resolve your issue with the summoner plugin.
@accalia tried to run and getting this
const path = require('path');
SyntaxError: Use of const in strict mode.
at exports.runInThisContext (vm.js:73:16)
at Module._compile (module.js:443:25)
at Object.Module._extensions..js (module.js:478:10)
at Module.load (module.js:355:32)
at Function.Module._load (module.js:310:12)
at Function.Module.runMain (module.js:501:10)
at startup (node.js:129:16)