Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 3.13 KB

README.md

File metadata and controls

56 lines (42 loc) · 3.13 KB

Commitizen friendly NPM Version Docs Status

Build Status Build status bitHound Overall Score Code Climate Test Coverage Package Quality

Dependency Status devDependency Status optionalDependency Status

SockBot

Greenkeeper badge Sockbot - A sock puppet robot worthy of TheDailyWTF in EcmaScript 6.

So how do I run this thing anyway?

The global method:

  1. npm install -g sockbot
  2. For any plugins you want to use, npm install -g [plugin]
  3. Create a config.json or config.yml (see samples for formatting)
  4. sockbot /path/to/config.json (or sockbot /path/to/config.yml

The local install method:

  1. In a directory you want to install, run npm init and answer the prompts
  2. npm install sockbot
  3. For any plugins you want to use, npm install [plugin]
  4. Create a config.json or config.yml
  5. node_modules/.bin/sockbot config.yml

Protip: When using the local install method, you can use a module like pm2 to persist the instance and keep track of logs.

Developers

SockBot is developed by members of SockDrawer

NOTA BENE

SockBot is designed for educational purposes, and is not intended to be used on typical production forums. It is also designed as an experiment of what can be automated within Discourse, and later NodeBB, and is generally targeted directly at what.thedailywtf.com.

This bot should not be used without the forum owners consent, and any use of this bot should be immediately discontinued at the request of the forum owners or moderators. SockBot is not intended for any ill purposes, and the designers of SockBot can not be held liable for abuses of the technology, or any software derived from it.