2014-09-02 20:54:42 +02:00
Tox-WeeChat
===========
2014-09-17 17:49:12 +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 and not intended for general use yet.
2014-09-02 20:54:42 +02:00
2014-09-17 17:49:12 +02:00
Current build status: [](https://travis-ci.org/haavardp/tox-weechat)
2014-09-02 22:38:30 +02:00
2014-09-02 20:54:42 +02:00
Installation
------------
2014-09-20 21:19:05 +02:00
> Tox-WeeChat is available in the [AUR][3].
2014-09-18 19:39:40 +02:00
2014-09-18 19:44:02 +02:00
Tox-WeeChat requires [WeeChat][1] >=1.0, [libjansson][4] >=2.5, and the latest-ish [libtoxcore][5]. It also requires CMake to be built. Installation is fairly simple; after getting the source, compile and install using CMake:
2014-09-02 20:54:42 +02:00
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
2014-09-18 20:17:07 +02:00
This installs the plugin binary `tox.so` to the recommended location `~/.weechat/plugins` . Omitting the home folder flag installs to `/usr/local/lib/weechat/plugins` . Installing to a custom WeeChat home or similar is achieved by setting `INSTALL_PATH` .
2014-09-02 20:54:42 +02:00
Usage
-----
2014-09-18 20:17:07 +02:00
- If the plugin does no automatically load, load it with `/plugin load tox` . You may have to specify the full path to the plugin binary.
2014-09-20 09:09:30 +02:00
- Create a new identity with `/tox create <name>` . The data file is stored in `~/.weechat/tox/` by default.
2014-09-17 17:49:12 +02:00
- Connect your identity to the Tox network with `/tox connect <name>` .
- Change your name with `/name <new name>` .
2014-09-19 17:53:11 +02:00
- Get your Tox ID with `/myid` .
2014-09-02 20:54:42 +02:00
- To add friends or respond to friend requests, `/help friend` will get you started.
2014-09-17 17:49:12 +02:00
- Message a friend with `/msg <friend number>` . Get their friend number with `/friend list` .
2014-09-02 20:54:42 +02:00
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-18 17:59:43 +02:00
TODO & Implemented features
2014-09-11 00:29:09 +02:00
----
2014-09-17 17:49:12 +02:00
- [x] Adding friends, one-to-one chats
2014-09-13 12:22:26 +02:00
- [x] Support multiple identities
2014-09-18 17:59:43 +02:00
- [x] Save friend requests
2014-09-18 00:15:53 +02:00
- [ ] Encrypted save files
2014-09-13 21:24:11 +02:00
- [ ] Tox DNS
2014-09-17 17:49:12 +02:00
- [ ] Group chats (awaiting libtoxcore implementation)
- [ ] Support proxies (TOR)
- [ ] A/V (long term)
2014-09-11 00:29:09 +02:00
2014-09-02 20:54:42 +02:00
License
---------
2014-09-18 18:55:52 +02:00
Copyright (c) 2014 Håvard Pettersson < haavard.pettersson @ gmail . com >
2014-09-02 20:54:42 +02:00
2014-09-18 18:55:52 +02:00
This file is part of Tox-WeeChat.
Tox-WeeChat is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Tox-WeeChat is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Tox-WeeChat. If not, see < http: / / www . gnu . org / licenses / > .
2014-09-02 20:54:42 +02:00
[1]: http://weechat.org
[2]: http://tox.im
2014-09-18 19:39:40 +02:00
[3]: https://aur.archlinux.org/packages/tox-weechat-git
[4]: http://www.digip.org/jansson/
[5]: https://github.com/irungentoo/toxcore
2014-09-02 21:14:05 +02:00
