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
118 Commits 1 Branch 0 Tags 637 KiB
C 96.5%
CMake 2.1%
Python 1.2%
Shell 0.2%
0e61f47b66
Go to file
Håvard Pettersson 0e61f47b66 Inverted function argument (keep_data -> delete_data).
2014-09-19 18:20:36 +02:00
src Inverted function argument (keep_data -> delete_data). 2014-09-19 18:20:36 +02:00
.gitignore Fixed YCM config gitignore. 2014-09-02 13:58:10 +02:00
.travis.yml Hopefully fixed Travis. 2014-09-18 18:31:08 +02:00
CMakeLists.txt Added tox-weechat-completion.{h,c}. 2014-09-19 16:55:11 +02:00
LICENSE Changed license to GPL3. 2014-09-18 18:56:43 +02:00
README.md Updated usage info. 2014-09-19 17:53:11 +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 and not intended for general use yet.

Current build status: Build Status

Installation

Tox-WeeChat is available on the AUR.

Tox-WeeChat requires WeeChat >=1.0, libjansson >=2.5, 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 -DHOME_FOLDER_INSTALL=ON ..
$ make
$ make install

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.

Usage

  • 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.
  • Create a new identity with /tox add <name>. The data file is stored in ~/.weechat/tox/ by default.
  • Connect your identity to the Tox network with /tox connect <name>.
  • Change your name with /name <new name>.
  • Get your Tox ID with /myid.
  • 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 list.

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

TODO & Implemented features

  • Adding friends, one-to-one chats
  • Support multiple identities
  • Save friend requests
  • Encrypted save files
  • Tox DNS
  • Group chats (awaiting libtoxcore implementation)
  • Support proxies (TOR)
  • A/V (long term)

License

Copyright (c) 2014 Håvard Pettersson haavard.pettersson@gmail.com

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