Skip to content

Latest commit

 

History

History
117 lines (73 loc) · 5.36 KB

README.md

File metadata and controls

117 lines (73 loc) · 5.36 KB
Raw

NodeEbot

Current Version: 0.2.1

This is NodeEbot (pronounced as "nodey bot" or even "naughty bot", if you prefer). It stands for Node E-books bot.

It's a Nodejs package for creating Twitter bots which can write their own tweets and interact with other users (by favoriting, replying, and following). This project draws heavy inspiration from the twitter_ebooks gem for Ruby.

You can see two examples of this bot in action at @daveleeeeee and @roboderp.

Quick Setup

You can run this app and start generating sentences without needing to have Twitter API credentials. Rename tweets.sample.txt to tweets.txt and start adding your own source material to this file. For best results, use one file per line.

Run the application like so...

node bot.js

Installation and Usage

This project was built using Node JS v8.3.0. I can't guarantee how well it will work with other versions of Node. If you're looking for a place to host Node projects, I've had success setting up a free Ubuntu virtual server through Amazon's Web Services dashboard and installing Node on it.

To run, copy the project into your preferred directory and then install the required dependencies using:

npm install

You can edit various configuration settings in the bot.js file. Before you can begin you'll need to have Twitter API credentials which can be setup right here. Once you have your consumer API key and secret as well as your access token and secret, add them to the config.js file found in the config folder:

// Twitter API configuration
var client = new Twitter({
  consumer_key: 'xxxx',
  consumer_secret: 'xxxx',
  access_token_key: 'xxxx',
  access_token_secret: 'xxxx'
});

You'll also need to add the Twitter username of your bot (without the @ symbol) to the config file. (This is for tracking mentions as well as making sure the bot ignores actions from itself so it doesn't get caught in a loop).

// Your robot's Twitter username (without the @ symbol)
// We use this to search for mentions of the robot and to prevent it from replying to itself
robotName = "xxxx";

Once that's done, the bot is almost ready to go. You can modify a few other settings that influence how chatty the bot is, how often it will interact with other users or use random hashtags and emojis.

In order to run the bot, I use the forever npm package. This allows us to automatically restart the server in case of a crash.

Source material

The one last thing that you'll need to do is give it some source material to generate text from. I use source material my own Twitter archive.

Right now, I haven't implemented a way to parse the Twitter's csv data that's generated when you request your history. In the meantime, I've simply opened up the tweets.csv in a spreadsheet app, copied the contents of the 'text' column into a new file and used that as the source material. This script will treat each line as a separate and unique sentence.

I've added some basic ability to strip our Twitter usernames and URLs from the archive. That means it will treat something like:

@davely That's great. I've seen something like that before.
http://flickr.com/...

as

That's great. I've seen something like that before.

Running multiple bots

If you want to run multiple bots for different Twitter accounts, copy this project into separate folders (e.g., ~/MyBot1, ~/MyBot2, ~/MyBot3, etc) and make sure you input the proper Twitter API credentials at the top of each bot.js file. Then spool up separate node instances and load up the relevant bot files.

Future things to do.

  • Turn it into a proper npm module.
  • Better regex handling to clean up source material (e.g., links, usernames, etc
  • Send direct messages back to users who DM our robot.
  • Keyword ranking of our source material. (Sort of implemented but disabled right now since performance is SLOW.)
  • Allow robot to reply with some content (e.g., if someone asks what it thinks about 'baseball,' it tries to compose a reply that mentions 'baseball.'
  • Retweet various tweets that it finds interesting based on keywords and interests.
  • Let it potentially upload images or GIFs.

Changelog

v 0.2.1 (2017/11/25)

  • Update Twitter and Bluebird libraries.
  • Run user content through cleanup method to strip usernames and links before building corpus.

v 0.2.0 (2015/10/06)

  • Better modularization. Also optimized some issues with how the robot looks for interests.

v 0.1.3 (2015/04/28)

  • Fixed bug that would cause bot to think that all users replying to it were found in our otherBots array and kept applying a temporary time out on replies, even if not needed.

v 0.1.2 (2015/04/27)

  • Implemented a hacky fix for an issue I'm having with the Twitter Streaming API randomly dying without an error. If we're running this with the npm package forever, let's kill the server and restart if ever few hours.

v 0.1.1 (2015/04/19)

  • Initial public release!

Other stuff

If you end up using this script in your own Twitter bots, let me know! I'd love to know how it works out for you and please let me know about any improvements or suggestions you might have.

Thanks for checking it out!

-@davely