2014-09-02 20:54:42 +02:00
Tox-WeeChat
===========
2014-10-11 10:32:11 +02:00
Tox-WeeChat is a [Tox][1] protocol plugin for [WeeChat][2]. It is functional, but lacks certain features like Tox DNS.
2014-09-02 20:54:42 +02:00
2014-09-30 20:40:24 +02:00
Current build status: [][3]
2014-09-02 22:38:30 +02:00
2014-11-19 12:37:19 +01:00
Features
--------
Below is a list of implemented features, as well as features that will be supported in the future.
- [x] One-to-one chats
- [x] Group chats (text only)
- [x] Proxies
- [x] Faux offline messaging
- [x] NoSpam editing
- [x] Multiple profiles
- [ ] Tox DNS
- [ ] Encrypted save files
- [ ] File transfer
- [ ] Avatars
- [ ] WeeChat `/upgrade`
- [ ] Audio/video
2014-09-02 20:54:42 +02:00
Installation
------------
2014-10-14 21:41:47 +02:00
> Tox-WeeChat is available in the [AUR][4] and the [[haavard]][5] pacman repository.
2014-09-18 19:39:40 +02:00
2014-10-18 02:45:23 +02:00
Tox-WeeChat requires [WeeChat][2] >= 1.0.1, [SQLite][6] >= 3.6.19 and the latest-ish [libtoxcore][7]. 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-10-11 13:16:18 +02:00
$ cmake -DPLUGIN_PATH=~/.weechat/plugins ..
2014-09-11 04:06:20 +02:00
$ make install
2014-10-11 13:16:18 +02:00
This installs the plugin binary `tox.so` to the recommended location `~/.weechat/plugins` . The default location is `/usr/local/lib/weechat/plugins` .
2014-09-02 20:54:42 +02:00
Usage
-----
2014-09-30 20:40:24 +02:00
- If the plugin does not load automatically, load it with `/plugin load tox` . You may have to specify the full path to the plugin binary.
2014-11-19 12:37:19 +01:00
- Create a new profile with `/tox create <profile name>` . The data file is stored in `~/.weechat/tox/` by default.
- Load your profile and connect to the Tox network with `/tox load <profile name>` .
- Run `/help -listfull tox` to get a list of all available commands, and `/set tox.*` for a list of options.
2014-09-02 20:54:42 +02:00
2014-10-08 11:51:50 +02:00
### Common issues
2014-10-07 12:59:46 +02:00
2014-10-08 11:51:50 +02:00
#### Long Tox names messing up WeeChat layout
2014-10-07 12:59:46 +02:00
Tox allows names up to 128 bytes long. To prevent long names from taking all your screen space, you can set the following options in WeeChat:
- `weechat.bar.nicklist.size_max`
- `weechat.look.prefix_align_max`
- `buffers.look.name_size_max` (if using buffers.pl)
2014-10-11 13:16:18 +02:00
#### Tox won't connect through my proxy
Make sure the address and port is correct, and that UDP is disabled (`/set tox.profile.*.udp`).
2014-09-02 20:54:42 +02:00
License
---------
2015-01-02 16:09:11 +01:00
Copyright (c) 2015 Håvard Pettersson < mail @ haavard . me >
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
2014-09-30 20:40:24 +02:00
[1]: http://tox.im
[2]: http://weechat.org
[3]: https://travis-ci.org/haavardp/tox-weechat
[4]: https://aur.archlinux.org/packages/tox-weechat-git
2014-10-14 21:41:47 +02:00
[5]: https://haavard.me/archlinux
[6]: http://www.sqlite.org
[7]: https://github.com/irungentoo/toxcore
2014-09-02 21:14:05 +02:00
