tox plugin for weechat - tox running as a weechat window

Go to file

Håvard Pettersson 2bcef77aa5 Update README.md		2014-09-11 04:07:03 +02:00
src	Fixed identity initialization.	2014-09-08 03:03:12 +02:00
.gitignore	Fixed YCM config gitignore.	2014-09-02 13:58:10 +02:00
.travis.yml	Use WeeChat 1.0 on Travis.	2014-09-03 14:36:54 +02:00
CMakeLists.txt	Improved build process and instructions.	2014-09-11 00:25:05 +02:00
LICENSE	Added README.md and LICENSE.	2014-09-02 20:54:42 +02:00
README.md	Update README.md	2014-09-11 04:07:03 +02:00

README.md

Tox-WeeChat

Tox-WeeChat is a C plugin for the WeeChat chat client that enables it to connect to the Tox network. It is functional, but fairly limited in features for now. Bug reports and suggestions are appreciated.

Installation

Tox-WeeChat requires libtoxcore (and WeeChat) to work. After getting them, install Tox-WeeChat like this:

$ git clone https://github.com/haavardp/tox-weechat.git
$ cd tox-weechat
$ mkdir build && cd build
$ cmake -DHOME_FOLDER_INSTALL=ON ..
$ make
$ make install

This installs the plugin binary tox.so in the recommended location ~/.weechat/plugins. To install the plugin somewhere else, replace the cmake command above with either of these:

To install to /usr/local/lib/weechat/plugins: cmake ..
To install to /usr/lib/weechat/plugins: cmake -DCMAKE_INSTALL_PREFIX=/usr ..
To install a custom path: cmake -DINSTALL_PATH=/some/path ..

You may also need to sudo make install, depending on permissions.

Usage

In WeeChat, load the plugin: /plugin load tox. In cases where WeeChat can't find the plugin, try specifying the full path to the binary. You should get a new buffer called tox. This is the core Tox buffer, where output from commands will appear.

To change your name, /name <new name>.
Get your Tox address with /myaddress.
To add friends or respond to friend requests, /help friend will get you started.
Message a friend with /msg <friend number>. Get their friend number with /friend.

A list of commands is available with /help -list tox.

TODO

Support multiple identities (in progress)
Preserve friend requests when closing
Group chats
Polish and reach a "stable" release

License

Tox-WeeChat is licensed under the MIT license. For more information, see the LICENSE file.