GitHub/dbot
3
0
Fork 1
mirror of https://github.com/reality/dbot.git synced 2024-12-24 11:42:36 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/reality/dbot
2,501 Commits 3 Branches 5 Tags 4.2 MiB
JavaScript 93%
Pug 5%
CSS 1.7%
Shell 0.3%
d7939a59cc
Go to file
Luke Slater d7939a59cc changes
2014-10-21 15:08:55 +00:00
jsbot@606d0cdcdd remember to commit new files 2014-10-03 21:00:57 +00:00
modules changes 2014-10-21 15:08:55 +00:00
public PART ONE #543 I THINK YES 2014-02-02 05:18:44 +00:00
views ok 2014-09-12 14:56:34 +00:00
.gitignore config.json s 2014-02-20 00:56:09 +01:00
.gitmodules TRANSLATIONS FROM ROI 2013-10-29 21:39:26 +00:00
config.json.sample Update config.json.sample 2014-07-22 22:20:14 +01:00
database.js well lets give this a try 2013-11-02 21:40:10 +00:00
install Just a minor fix to a filename 2014-09-02 18:58:32 +01: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 remove tilde prefix for command usage 2014-09-13 19:40: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!