summaryrefslogtreecommitdiff
path: root/README.md
blob: da8123e0bbc6c271ae6c93719ad22c1f36acbe95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# snekeyes
Dice rolling bot for Matrix using the granolin bot framework.
More documentation will come...

## Setup

Create a `snekeyes.config` file in the directory from which
you will launch the bot.

```
(:ssl t                         ;; in the case of a local testing server, the default is t
 :hardcopy "snekeyes.hardcopy"  ;; for recovering sessions, this file will be created 
 :user-id  "some-id"            ;; the user you have already created on your server for the bot
 :password "some-password"
 :homeserver "matrix.cicadas.surf"    ;; or your real one
)
```

## Commands

Currently, `snekeyes` supports two commands:
  - `craps!` which rolls two six-sided dice. You win if the total is 7.
  - `roll! NdS` which rolls N dice with S sides. `roll! 5` will roll 5 six-sided dice.