https://github.com/rockorager/comlink

An experimental IRC client
https://github.com/rockorager/comlink

irc irc-client zig

Last synced: 3 months ago
JSON representation

An experimental IRC client

• Host: GitHub
• URL: https://github.com/rockorager/comlink
• Owner: rockorager
• License: mit
• Created: 2024-05-31T01:17:58.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-31T20:42:35.000Z (3 months ago)
• Last Synced: 2024-10-31T21:26:59.082Z (3 months ago)
• Topics: irc, irc-client, zig
• Language: Zig
• Homepage:
• Size: 1.45 MB
• Stars: 17
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# comlink

An experimental IRC client written in zig. Join the discussion in #comlink on

libera.chat.

![screenshot of comlink](screenshot.png)

## Installation

`comlink` is written in zig and can be installed using the zig build system,

version 0.13.0.

```sh

git clone https://github.com/rockorager/comlink

cd comlink

zig build -Doptimize=ReleaseSafe --prefix ~/.local

```

## Configuration

Configuration is loaded from `$HOME/.config/comlink/init.lua`

Works best with `soju`. pico.sh runs a free instance of `soju` and has fantastic

[documentation](https://pico.sh/irc) on how to get connected

```lua

local comlink = require("comlink")

local config = {

	server = "chat.sr.ht",

	user = "rockorager",

	nick = "rockorager",

	password = "password",

	real_name = "Tim Culverhouse",

	tls = true,

}

-- Pass the server config to connect. Connect to as many servers as you need

comlink.connect(config)

-- Bind a key to an action

comlink.bind("ctrl+c", "quit")

```

## Contributing

Patches accepted on the [mailing list](https://lists.sr.ht/~rockorager/comlink)

Pull requests accepted on [Github](https://github.com/rockorager/comlink)