2014-09-02 20:54:42 +02:00
Tox-WeeChat
===========
2014-09-11 00:29:09 +02:00
Tox-WeeChat is a C plugin for the [WeeChat][1] chat client that enables it to connect to the [Tox][2] network. It is functional, but fairly limited in features for now. Bug reports and suggestions are appreciated.
2014-09-02 20:54:42 +02:00
2014-09-02 22:38:30 +02:00
[](https://travis-ci.org/haavardp/tox-weechat)
2014-09-02 20:54:42 +02:00
Installation
------------
2014-09-10 02:45:12 +02:00
Tox-WeeChat requires [libtoxcore][3] (and WeeChat) to work. After getting them, install Tox-WeeChat like this:
2014-09-02 20:54:42 +02:00
2014-09-02 21:10:00 +02:00
$ git clone https://github.com/haavardp/tox-weechat.git
$ cd tox-weechat
2014-09-02 23:27:53 +02:00
$ mkdir build & & cd build
2014-09-11 04:06:20 +02:00
$ 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:
2014-09-02 20:54:42 +02:00
2014-09-11 00:39:56 +02:00
- To install to `/usr/local/lib/weechat/plugins` : `cmake ..`
- To install to `/usr/lib/weechat/plugins` : `cmake -DCMAKE_INSTALL_PREFIX=/usr ..`
2014-09-11 04:06:20 +02:00
- To install a custom path: `cmake -DINSTALL_PATH=/some/path ..`
2014-09-11 04:07:03 +02:00
You may also need to `sudo make install` , depending on permissions.
2014-09-02 20:54:42 +02:00
Usage
-----
2014-09-13 12:22:26 +02:00
- In WeeChat, load the plugin with `/plugin load tox` . If it fails, try specifying the full path to the binary.
2014-09-13 12:27:40 +02:00
- Create a new identity with `/tox add <name>` .
- The data file is created in `<WeeChat home>/tox/<name>` by default.
- Can be changed with `/set tox.identity.<name>.save_file` .
2014-09-13 12:22:26 +02:00
- Connect your new identity to the Tox network with `/tox connect <name>` .
The following commands must be executed on a Tox buffer:
2014-09-02 20:54:42 +02:00
- 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` .
2014-09-03 00:22:35 +02:00
A list of commands is available with `/help -list tox` .
2014-09-02 20:54:42 +02:00
2014-09-11 00:29:09 +02:00
TODO
----
2014-09-13 12:22:26 +02:00
- [x] Support multiple identities
2014-09-11 00:29:09 +02:00
- [ ] Preserve friend requests when closing
- [ ] Group chats
2014-09-13 21:24:11 +02:00
- [ ] Tox DNS
2014-09-11 00:29:09 +02:00
- [ ] Polish and reach a "stable" release
2014-09-13 12:22:26 +02:00
- [ ] Add autocomplete to all commands
2014-09-11 00:29:09 +02:00
2014-09-02 20:54:42 +02:00
License
---------
Tox-WeeChat is licensed under the MIT license. For more information, see the LICENSE file.
2014-09-02 21:10:00 +02:00
Copyright (c) 2014 Håvard Pettersson < haavard.pettersson @ gmail . com > .
2014-09-02 20:54:42 +02:00
[1]: http://weechat.org
[2]: http://tox.im
[3]: https://github.com/irungentoo/toxcore
2014-09-02 21:14:05 +02:00
