A C library to develop services and tools for Tox.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
scripts
src
.gitignore
.gitmodules
.travis.yml
LICENSE
README.md
TODO.md
ToxShare.md
ToxSuite.pro

README.md

ToxSuite

NOT READY FOR PRODUCTION

ToxSuite is a C helper library on top of Toxcore to develop services and tools for Tox.
See tox.chat for information about Tox in general.

License Coverity Scan Build Status Build Status


Features

  • modular : code is split to different files
  • fopencookie : write message to friend with standard stream
  • libsodium : decryption/encryption support of toxfile
  • libsndfile : audio streaming/recording
  • ylog : low-level logging system
  • captcha : can generate captcha to deal with spammer

The ToxSuite comes with two tools :

  • Suit : a Tox bot performing ala Skype calltest.
  • Toxdatatool : a tool for processing toxfile.

Installation

Currently, ToxSuite uses qmake to generate Makefile and is only tested on GNU/Linux 64 bits.

Build Toxdatatool

$ qmake -config toxdatatool
$ make

Build Suit

$ qmake -config suite
$ make

Suit

Suit bot on Tox. No configuration file yet.

Usage

As a quick hack, Suit uses getenv() to check for the following environment variables :

  • SUIT_HOME
  • SUIT_PASSPHRASE
  • SUIT_NAME
  • SUIT_STATUSMSG

an example to how to set it properly is provided in scripts/suit.sh .

$ source suit.sh
$ ./suit

Suit will go background as it provides a minimal daemon feature. Toxcore datas file is read from SUIT_HOME directory, and Suit will write its logs there.

Toxdatatool

Tox profile management.

Usage

$ ./toxdatatool -?
Usage: toxdatatool <toxfile>
-s, --passphrase=<passphrase>     Use passphrase to encrypt/decrypt toxfile.
-x, --export=<tox.keys>           Export friends's tox publickey into file.
-i, --import=<tox.keys>           Import friends from tox publickey file.
-r, --remove=<expire.keys>        Remove friends from tox publickey file.
-u, --purge=<delay in second>     Purge friends toxfile not seen since <delay>
-p, --print                       Print content of toxfile (after modification if any).
-v, --verbose                     Be verbose

Help options:
-?, --help                        Show this help message
--usage                       Display brief usage message