| 1 | # Clients
|
|---|
| 2 |
|
|---|
| 3 | This page describes how to configure IRC clients to better integrate with soju.
|
|---|
| 4 |
|
|---|
| 5 | Also see the [IRCv3 support tables] for a more general list of clients.
|
|---|
| 6 |
|
|---|
| 7 | # catgirl
|
|---|
| 8 |
|
|---|
| 9 | catgirl doesn't properly implement cap-3.2, so many capabilities will be
|
|---|
| 10 | disabled. catgirl developers have publicly stated that supporting bouncers such
|
|---|
| 11 | as soju is a non-goal.
|
|---|
| 12 |
|
|---|
| 13 | # [Emacs]
|
|---|
| 14 |
|
|---|
| 15 | There are two clients provided with Emacs. They require some setup to work
|
|---|
| 16 | properly.
|
|---|
| 17 |
|
|---|
| 18 | ## Erc
|
|---|
| 19 |
|
|---|
| 20 | You need to explicitly set the username, which is the defcustom
|
|---|
| 21 | `erc-email-userid`.
|
|---|
| 22 |
|
|---|
| 23 | ```elisp
|
|---|
| 24 | (setq erc-email-userid "<username>/irc.libera.chat") ;; Example with Libera.Chat
|
|---|
| 25 | (defun run-erc ()
|
|---|
| 26 | (interactive)
|
|---|
| 27 | (erc-tls :server "<server>"
|
|---|
| 28 | :port 6697
|
|---|
| 29 | :nick "<nick>"
|
|---|
| 30 | :password "<password>"))
|
|---|
| 31 | ```
|
|---|
| 32 |
|
|---|
| 33 | Then run `M-x run-erc`.
|
|---|
| 34 |
|
|---|
| 35 | ## Rcirc
|
|---|
| 36 |
|
|---|
| 37 | The only thing needed here is the general config:
|
|---|
| 38 |
|
|---|
| 39 | ```elisp
|
|---|
| 40 | (setq rcirc-server-alist
|
|---|
| 41 | '(("<server>"
|
|---|
| 42 | :port 6697
|
|---|
| 43 | :encryption tls
|
|---|
| 44 | :nick "<nick>"
|
|---|
| 45 | :user-name "<username>/irc.libera.chat" ;; Example with Libera.Chat
|
|---|
| 46 | :password "<password>")))
|
|---|
| 47 | ```
|
|---|
| 48 |
|
|---|
| 49 | Then run `M-x irc`.
|
|---|
| 50 |
|
|---|
| 51 | # [gamja]
|
|---|
| 52 |
|
|---|
| 53 | gamja has been designed together with soju, so should have excellent
|
|---|
| 54 | integration. gamja supports many IRCv3 features including chat history.
|
|---|
| 55 | gamja also provides UI to manage soju networks via the
|
|---|
| 56 | `soju.im/bouncer-networks` extension.
|
|---|
| 57 |
|
|---|
| 58 | # [goguma]
|
|---|
| 59 |
|
|---|
| 60 | Much like gamja, goguma has been designed together with soju, so should have
|
|---|
| 61 | excellent integration. goguma supports many IRCv3 features including chat
|
|---|
| 62 | history. goguma should seamlessly connect to all networks configured in soju via
|
|---|
| 63 | the `soju.im/bouncer-networks` extension.
|
|---|
| 64 |
|
|---|
| 65 | # [Hexchat]
|
|---|
| 66 |
|
|---|
| 67 | Hexchat has support for a small set of IRCv3 capabilities. To prevent
|
|---|
| 68 | automatically reconnecting to channels parted from soju, and prevent buffering
|
|---|
| 69 | outgoing messages:
|
|---|
| 70 |
|
|---|
| 71 | /set irc_reconnect_rejoin off
|
|---|
| 72 | /set net_throttle off
|
|---|
| 73 |
|
|---|
| 74 | # [senpai]
|
|---|
| 75 |
|
|---|
| 76 | senpai is being developed with soju in mind, so should have excellent
|
|---|
| 77 | integration. senpai supports many IRCv3 features including chat history.
|
|---|
| 78 |
|
|---|
| 79 | # [Weechat]
|
|---|
| 80 |
|
|---|
| 81 | A [Weechat script] is available to provide better integration with soju.
|
|---|
| 82 | The script will automatically connect to all of your networks once a
|
|---|
| 83 | single connection to soju is set up in Weechat.
|
|---|
| 84 |
|
|---|
| 85 | On WeeChat 3.2-, no IRCv3 capabilities are enabled by default. To enable them:
|
|---|
| 86 |
|
|---|
| 87 | /set irc.server_default.capabilities account-notify,away-notify,cap-notify,chghost,extended-join,invite-notify,multi-prefix,server-time,userhost-in-names
|
|---|
| 88 | /save
|
|---|
| 89 | /reconnect -all
|
|---|
| 90 |
|
|---|
| 91 | See `/help cap` for more information.
|
|---|
| 92 |
|
|---|
| 93 | [IRCv3 support tables]: https://ircv3.net/software/clients
|
|---|
| 94 | [gamja]: https://sr.ht/~emersion/gamja/
|
|---|
| 95 | [goguma]: https://sr.ht/~emersion/goguma/
|
|---|
| 96 | [senpai]: https://sr.ht/~taiite/senpai/
|
|---|
| 97 | [Weechat]: https://weechat.org/
|
|---|
| 98 | [Weechat script]: https://github.com/weechat/scripts/blob/master/python/soju.py
|
|---|
| 99 | [Hexchat]: https://hexchat.github.io/
|
|---|
| 100 | [Emacs]: https://www.gnu.org/software/emacs/
|
|---|
