dbot/README.md
2012-03-10 19:53:11 +00:00

3.0 KiB
Raw Blame History

Depressionbot IRC Bot

Introduction

Depressionbot is an IRC bot which aims to be the fanciest IRC bot around - On the general standard of software fanciness, dbot is rated as being 75% the same as bathing in fine, fine grape juice.

Requirements: - Node JS - JSbot, the Javascript library I wrote to handle the IRC protocol and event listeners etc. - Various modules have their own requirements also.

Modules:

Quotes

This is the original reason that DBot was created.

Commands:

  • ~q category - Display a random quote from a given category.
  • ~qadd category=newquote - Add a new quote to the database.
  • ~qstats - Show a list of the biggest quote categories.
  • ~qsearch category needle - Search for a quote in a given category.
  • ~rmlast [category] - Remove the last quote added to a given category, or the last quote added.
  • ~rm category quote - Remove a given quote from the given category.
  • ~qcount category - Show the number of quotes stored in the given category.
  • ~rq - Show a random quote from a random category.
  • ~d - Show a quote from the category which matches the bots name.
  • ~link category - Create a link to the page on the web interface which displays the given categorys quotes.
  • ~qprune - Delete empty quote categories.

Admin

Various administration functionality such as banning users, hot-reloading the code and ordering him to talk. Note that commands added here are handled with their own listener, rather than being part of the command logic which is handled by the Command module. Functionality in this module can be slightly unsafe as not much error checking on the input is performed.

JS - Run Javascript code

This module provides two commands which allow the execution of Javascript code. For regular users, there is the ~js command, which is completely sandboxed, but can still be used for calculation and the like.

> ~js Array(16).join('wat'-1) + " Batman!";
'NaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaN Batman!'

This feature is fairly safe as the user doesnt have access to anything dangerous, and is safe from infinite loops or locking DBot up because the code which is run is killed if it does not finish within a short amount of time.

For administrators, the incredibly useful ~ajs command is also available. The input for this command is simply eval-ed and therefore has full access to DBots memory. Of course, this is incredibly unsafe, but I find it rather fun; remember to only give extremely trusted friends administrator access to DBot, as theres nothing to stop them wiping the database or something similar - if youre worried about that kind of thing, do not load this module.

However, its useful for many things, such as administrative activity for which there isnt a command in the admin module. For example, you could hot-add a new administrator like this:

> ~ajs dbot.admin.push('batman');
2

You can also use this for debugging, or even adding new commands while DBot is running.