Sockbot - A sock puppet Robot worthy of TheDailyWTF that interfaces with what.thedailywtf.com. SO META!
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
docs docs: Update API Documentation Oct 14, 2017
lib chore: fix codeclimate issues Dec 21, 2016
plugins chore: fix lint errors in new version of lint. Jun 24, 2017
providers/nodebb chore(provider): Indicate availability of avatar upload capability Oct 14, 2017
test feat(provider/user): Allow Uploading/setting of user avatar from with… Oct 13, 2017
.codeclimate.yml
.eslintignore
.eslintrc.json
.gitattributes chore: update .gitattributes to ident package.json Dec 21, 2016
.gitignore feat(provider/user): Allow Uploading/setting of user avatar from with… Oct 13, 2017
.istanbul.yml chore(build): Update istanbul options to be recognized on windows Jun 28, 2016
.npmignore chore(publish): Add npmignore to remove unneeded files from publish Jun 28, 2016
.travis.yml chore(versions): Remove Node version 4.0 from test suite. Remove vers… Jun 23, 2018
CODE_OF_CONDUCT.md docs(CONTRIBUTING): Add Contribution and Code of Conduct Guidelines Jun 7, 2016
CONTRIBUTING.md chore(docs): Update CONTRIBUTINGG.md Apr 12, 2017
LICENSE update branch references and add license to docs Aug 15, 2015
README.md docs(readme): add Greenkeeper badge May 3, 2017
appveyor.yml chore(versions): Remove Node version 4.0 from test suite. Remove vers… Jun 23, 2018
example.config.yml
jsconfig.json jsconfig.json file for VSCode ES6 mode Jul 28, 2015
mkdocs.yml where does this blasted mkdics yaml file go? Jul 9, 2015
package.json fix(package): update request to version 2.88.0 Aug 10, 2018

README.md

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.