aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 51cd34f5012137070dc09a93c283c6bfd9903707 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# IRC Utilities for Go

This is a small collection of utilities for interacting with IRC in Go.

### `hbot` - small bot and message parsing library

Based on [hellabot](https://github.com/whyrusleeping/hellabot), [kittybot](https://github.com/ugjka/kittybot), and [sorcix-irc](https://github.com/sorcix/irc).

This is a simple message parser and trigger-based IRC client library.

```go
import "golang.zx2c4.com/irc/hbot"
```

### `ircmirror` - mirrors one channel to another, one-way

To assist in channel migrations, this mirrors messages from one channel to another, by joining the source channel from several IP addresses via WireGuard.

```go
go get golang.zx2c4.com/irc/cmd/ircmirror
```

### `irc-simple-responder` - responds to all messages

This is best used with `+z` in a channel. It responds to all messages with a static string.


```go
go get golang.zx2c4.com/irc/cmd/irc-simple-responder
```

### `wurgurboo` - the "WurGurBoo" bot for `#wireguard`

This polls for commits and does various things in the `#wireguard` channel. It's meant to be run as a [`go-web-service`](https://git.zx2c4.com/go-web-services/).

```go
go get golang.zx2c4.com/irc/cmd/wurgurboo
```