Georg/dbot
1
0
Fork 0
forked from GitHub/dbot
Code Issues Pull Requests Projects Releases Wiki Activity
Bringing https://github.com/reality/dbot to the 21st century - again.
2,327 Commits 3 Branches 0 Tags 3.9 MiB
JavaScript 96.4%
Pug 2.6%
CSS 0.9%
Shell 0.1%
39d0bd7058
Go to file
reality 39d0bd7058 Quiet no longer uses chanserv. Some cleanup of host code. Should fix [#601]
2014-02-03 17:37:38 +00:00
jsbot@750dacdcd8 update jsbot 2014-01-06 17:42:01 +00:00
modules Quiet no longer uses chanserv. Some cleanup of host code. Should fix [#601] 2014-02-03 17:37:38 +00:00
public TRANSLATIONS FROM ROI 2013-10-29 21:39:26 +00:00
views fix the poll views 2014-01-29 22:42:16 +00:00
.gitignore update gitignore 2013-04-18 08:37:30 +00:00
.gitmodules TRANSLATIONS FROM ROI 2013-10-29 21:39:26 +00:00
config.json.sample include channel in logs 2013-08-31 13:30:24 +00:00
database.js well lets give this a try 2013-11-02 21:40:10 +00:00
install add crypto-js to the npm dependencies, merge #600 [Close #600] 2013-12-26 17:09:12 +00:00
LICENCE GPL 2013-04-22 19:36:13 +00:00
README.md install must be run with bash, not sh 2013-08-31 03:15:20 +02:00
run.js initial support for optional command prefix. module commands can currently either use ~command or just command as key, since module loader implements legacy support by shifting the key. there may be a couple of bugs too if there are any recursive commands 2013-12-29 18:13:59 +00:00
snippets.js remove chancein 2013-05-17 17:04:55 +00:00
strings.json TRANSLATIONS FROM ROI 2013-10-29 21:39:26 +00:00
VERSION start 0.5 dev 2013-07-25 21:50:29 +00:00

README.md

DBot IRC Bot

Introduction

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

Please note that this documentation is not complete and is a work in progress, given I started it rather a long time after I began development of the project. Please don’t judge me too harshly for this as I am, in fact, mildly allergic to writing documentation.

Getting Started

To get started with DBot, you first need to decide on a database system to use. DBot uses the databank library, and each module can be configured to use any database driver databank supports in its respective config.json file. There is currently no default database driver option.

The default for all modules is the ‘redis’ driver, and you can simply install the Redis server to get going.

Once you have that set up, you can install DBot’s dependencies, configure and run the bot for the first time with the following command:

./install

Upgrading

If you have used a previous version of DBot, then you can migrate most data using the dbot-migrate module. Instructions on how to run this are included in the repository - remember to remove db.json after migration, otherwise the instance will be slow!