# IRCHeisenbridge brings IRC to Matrix by creating an environment where every user connects to each network individually like they would with a traditional IRC bouncer.

## Features

What the IRC bridge can do

| Feature                                                                                     |
|---------------------------------------------------------------------------------------------|
| Zero configuration: no databases or storage required                                        |
| Brings IRC to Matrix: not annoying to folks on IRC                                          |
| Completely managed through an admin room                                                    |
| Channel management through the bridge bot                                                   |
| Access control for local and federated users                                                |
| Configurable IRC user synchronization (full sync on connect, half on join, or lazy on talk) |
| Optional room plumbing with single puppeting on Matrix and relaybot on IRC                  |
| IRCnet !channels support                                                                    |
| Any number of IRC networks and users                                                        |
| Channel customization: name and avatar                                                      |
| TLS support for IRC networks                                                                |
| Customizable ident support                                                                  |
| Configurable pillifying of IRC nicks                                                        |
| Long message splitting for IRC                                                              |
| Smart formatting from Matrix to IRC using IRC conventions                                   |
| Smart message edits (sends only corrections)                                                |
| Automatic identify and auth with server password or command on connect                      |
| SASL PLAIN and CertFP authentication                                                        |
| CTCP support                                                                                |
| SOCKS proxy configuration per server                                                        |
| Bridge-managed spaces to organize channels and PMs                                          |

## Usage

Start a chat with `@heisenbridge:your-server.com`. When it joins, type `help` in the chat to see instructions.

1. Send `addnetwork network.name` to the bridge bot, eg: `addnetwork libera.chat`
2. Send `addserver network.name irc-server.address port --tls` to the bridge bot, eg: `addserver libera.chat irc.libera.chat 6697 --tls`
3. Send `open network.name` to the bridge bot, eg: `open libera.chat`. The bridge bot will create a control room for that IRC network and invite you
4. In the new room, read the bot instructions in the first room message and configure it as you wish, after that send `connect`
5. Send `join #room-name` to the bot to bridge into an IRC room

> **Pro Tip!** You can allow other users (even from other homeservers) to use your bridge by sending `addmask @user:some-server.com` or even `addmask *:other-server.com` to the bot


---
* [llms.txt](https://etke.cc/llms.txt): full site index in markdown
