source: code/trunk/contrib/clients.md@ 796

Last change on this file since 796 was 796, checked in by contact, 3 years ago

contrib/clients: warn about catgirl

File size: 2.6 KB
RevLine 
[518]1# Clients
2
3This page describes how to configure IRC clients to better integrate with soju.
4
5Also see the [IRCv3 support tables] for a more general list of clients.
6
[796]7# catgirl
8
9catgirl doesn't properly implement cap-3.2, so many capabilities will be
10disabled. catgirl developers have publicly stated that supporting bouncers such
11as soju is a non-goal.
12
[765]13# [Emacs]
14
15There are two clients provided with Emacs. They require some setup to work
16properly.
17
18## Erc
19
20You 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
33Then run `M-x run-erc`.
34
35## Rcirc
36
37The 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
49Then run `M-x irc`.
50
[518]51# [gamja]
52
53gamja has been designed together with soju, so should have excellent
54integration. gamja supports many IRCv3 features including chat history.
[538]55gamja also provides UI to manage soju networks via the
56`soju.im/bouncer-networks` extension.
[518]57
[579]58# [Hexchat]
59
60Hexchat has support for a small set of IRCv3 capabilities. To prevent
61automatically reconnecting to channels parted from soju, and prevent buffering
62outgoing messages:
63
64 /set irc_reconnect_rejoin off
65 /set net_throttle off
66
[518]67# [senpai]
68
69senpai is being developed with soju in mind, so should have excellent
70integration. senpai supports many IRCv3 features including chat history.
71
72# [Weechat]
73
[718]74A [Weechat script] is available to provide better integration with soju.
75The script will automatically connect to all of your networks once a
76single connection to soju is set up in Weechat.
[518]77
[718]78On WeeChat 3.2-, no IRCv3 capabilities are enabled by default. To enable them:
79
80 /set irc.server_default.capabilities account-notify,away-notify,cap-notify,chghost,extended-join,invite-notify,multi-prefix,server-time,userhost-in-names
[518]81 /save
82 /reconnect -all
83
84See `/help cap` for more information.
85
86[IRCv3 support tables]: https://ircv3.net/software/clients
87[gamja]: https://sr.ht/~emersion/gamja/
88[senpai]: https://sr.ht/~taiite/senpai/
89[Weechat]: https://weechat.org/
[557]90[Weechat script]: https://github.com/weechat/scripts/blob/master/python/soju.py
[578]91[Hexchat]: https://hexchat.github.io/
[765]92[Emacs]: https://www.gnu.org/software/emacs/
Note: See TracBrowser for help on using the repository browser.