rockorager.dev
an experimental irc client
1# comlink
2
3An experimental IRC client written in zig. Join the discussion in #comlink on
4libera.chat.
5
6
7
8## Installation
9
10### Arch Linux
11
12[comlink](https://aur.archlinux.org/packages/comlink) is available as a package in the AUR. It can be installed using an AUR helper (e.g. paru).
13
14```sh
15paru -S comlink
16```
17
18### Zig Build System
19
20`comlink` is written in zig and can be installed using the zig build system,
21version 0.14.0.
22
23```sh
24git clone https://github.com/rockorager/comlink
25cd comlink
26zig build -Doptimize=ReleaseSafe --prefix ~/.local
27```
28
29## Configuration
30
31Configuration is loaded from `$HOME/.config/comlink/init.lua`
32
33Works best with `soju`. pico.sh runs a free instance of `soju` and has fantastic
34[documentation](https://pico.sh/irc) on how to get connected
35
36```lua
37local comlink = require("comlink")
38
39local config = {
40 server = "chat.sr.ht",
41 user = "rockorager",
42 nick = "rockorager",
43 password = "password",
44 real_name = "Tim Culverhouse",
45 tls = true,
46}
47
48-- Pass the server config to connect. Connect to as many servers as you need
49comlink.connect(config)
50
51-- Bind a key to an action
52comlink.bind("ctrl+c", "quit")
53```
54
55## Contributing
56
57Patches accepted on the [mailing list](https://lists.sr.ht/~rockorager/comlink)
58
59Pull requests accepted on [Github](https://github.com/rockorager/comlink)