emdee/tox-weechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
tox plugin for weechat - tox running as a weechat window
259 Commits 1 Branch 0 Tags 637 KiB
C 96.5%
CMake 2.1%
Python 1.2%
Shell 0.2%
d27f817777
Go to file
Håvard Pettersson d27f817777 Merge branch 'spacefrogg-master'
2015-08-26 20:08:26 +02:00
cmake Added CMake find modules, fixing build on FreeBSD. 2015-01-30 13:55:19 +00:00
src Removed unused function. 2015-08-26 20:07:03 +02:00
.gitignore Fixed YCM config gitignore. 2014-09-02 13:58:10 +02:00
.travis.yml Bumped libsodium version on Travis to 1.0.0. 2014-11-19 06:23:27 +01:00
CMakeLists.txt Added CMake find modules, fixing build on FreeBSD. 2015-01-30 13:55:19 +00:00
LICENSE Changed license to GPL3. 2014-09-18 18:56:43 +02:00
README.md Got rid of SQLite. 2015-01-06 16:15:27 +01:00

README.md

Tox-WeeChat

Tox-WeeChat is a Tox protocol plugin for WeeChat. It is functional, but lacks certain features like Tox DNS.

Current build status: Build Status

Features

Below is a list of implemented features, as well as a rough roadmap for the future.

  • One-to-one chats
  • Group chats (text only)
  • Proxy support
  • Multiple profiles
  • Tox DNS
  • Encrypted save files
  • File transfer
  • Avatars
  • WeeChat /upgrade
  • Audio/video

Installation

Tox-WeeChat is available in the AUR and the [haavard] pacman repository.

Tox-WeeChat requires WeeChat >= 1.0.1 and the latest-ish libtoxcore. It also requires CMake to be built. Installation is fairly simple; after getting the source, compile and install using CMake:

$ mkdir build && cd build
$ cmake -DPLUGIN_PATH=~/.weechat/plugins ..
$ make install

This installs the plugin binary tox.so to the recommended location ~/.weechat/plugins. The default location is /usr/local/lib/weechat/plugins.

Usage

  • 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.
  • 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.

Common issues

Long Tox names messing up WeeChat layout

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)

Tox won't connect through my proxy

Make sure the proxy type, address and port is correct, and that UDP is disabled (/set tox.profile.*.udp).

License

Copyright (c) 2015 Håvard Pettersson mail@haavard.me

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/.