mai

maidbot

An advanced Twitter bot inspired by twittbot.net

Showing:

Popularity

Downloads/wk

48

GitHub Stars

8

Maintenance

Last Commit

5yrs ago

Contributors

1

Package

Dependencies

5

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Twitter bot inspired by twittbot.net. Gittip Build Status NPM version Dependency Status Code Climate

Installation

$ npm install -g maidbot

Running

$ maidbot config_file.json

Configuration

Maidbot uses JSON files for configuration. There's an example configuration file under test/examples/maidbot.json and a JSON schema under core/schema.js.

Example configuration

// Don't copy and paste this.
var maidbot_config = {
  "twitter_api": { // Twitter API settings. See: http://dev.twitter.com. Required.
    "consumer_key": "",
    "consumer_secret": "",
    "access_token": "",
    "access_token_secret": ""
  },

  "auto_follow_back": true, // Follow new followers back. Defaults to true.
  "random_tweet_enable": true, // Update status with random tweets at given intervals. Defaults to true.
  "random_tweet_interval": 60, // Random status interval, in minutes. Defaults to 60 minutes.
  "filters_case_insensitive": true, // Whether filters should be case-insensitive. Defaults to true.

  "tweets": [ // Array of statuses to make.
    { "body": "I shall make you some tea", // Tweet body.
      "type": ["timeline", "random"], // Array of status types. Timeline tweets will be handled by onTimelineTweet(), replies by onReply(), etc. Possible values: random, timeline, reply, follower. Required. Must not be empty.
      "filters": { // Filters object.
        "regexp": "thirsty|make.+(?:tea)" // This status will be used as a possible response to tweets matching this pattern.
        // Other types of filters: regexp, matches, userid.
      }
    }
  ],

  "ignored_users": ["148684820"] // Array of user IDs to silently ignore.
};

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100