Please note: This README is work in progress. A more detailed documentation will follow.

weechat.el requires Emacs 24 and s.el. For Emacs versions below 24.3 you also need cl-lib. WeeChat version 0.4.0 or newer is recommended!

You can install both s and cl-lib via package.el (marmelade required):

M-x package-install RET s RET
M-x package-install RET cl-lib RET

First, setup the relay server in weechat. Please refer to the manual.

To load and establish a connection:

(require 'weechat)
M-x weechat-connect

To show a channel in Emacs, do:

M-x weechat-monitor-buffer

Most colors in weechat.el come directly from WeeChat and are only translated into Emacs faces. There are a few notable exceptions such as weechat-highlight-face or weechat-nick-self-face.

If you are unsatisfied with the colors that WeeChat send then either change the corresponding color in WeeChat or customize weechat-color-list. Do not add or remove any values in the list! Simply change the value. Using rainbow-mode (from GNU ELPA) or list-colors-display can help finding good values.

The default configuration tries to match the WeeChat colors as close as possible. Example for colors that go better with the Emacs’ default theme are:

(setq weechat-color-list '(unspecified "black" "dim gray" "dark red" "red"
                                       "dark green" "green" "brown"
                                       "orange" "dark blue" "blue"
                                       "dark magenta" "magenta" "dark cyan"
                                       "royal blue" "dark gray" "gray"))

If you do not want any color then set weechat-debug-strip-formatting to t.

See documentation in SSL.org.

Weechat.el comes with module support. Modules can be loaded by simply calling load-library and removed by using unload-feature. The variable weechat-modules can be customized to set default loaded modules.

Available modules are:

This module provides support for buttons in chat windows. E.g., it turns URLs into clickable buttons. The module is default loaded. See weechat-modules.

It supports several types of buttons such as URLs, Channels, Emacs’ symbols, E-Mails, Manpages, Info links, and Nick names. However not all buttons are activated as default. See customization group weechat-button to enable and disable specific buttons.

You can use weechat-button-list to simply add your own button types.

This module provides support for nickname and command completion. It uses Emacs’ pcomplete framework and is default loaded.

This module provides spelling support by using Emacs’ flyspell. You can customize the dictionary on a per channel/server basis by customizing weechat-spelling-dictionaries.

This module uses Gnus’ smiley-region support to convert text smileys, such as :-), into a graphical representation. See the documentation of smiley.el on how to customize it.

Feel free to contact us via Github, Email, or IRC (#weechat.el on Freenode)

Please add yourself to this list when you contribute code!

• Moritz Ulrich (Maintainer)
• Rüdiger Sonderfeld
• Aristid Breitkreuz