#p2p #instant-messaging #networking #tox #toxcore

tox

Implementation of toxcore in pure Rust - P2P, distributed, encrypted, easy to use DHT-based network

10 releases

✓ Uses Rust 2018 edition

0.0.10 May 27, 2019
0.0.9 Jan 27, 2019
0.0.8 Dec 27, 2018
0.0.7 Oct 27, 2018
0.0.1 Dec 31, 2014

#17 in Multimedia

Download history 34/week @ 2019-05-20 177/week @ 2019-05-27 23/week @ 2019-06-03 12/week @ 2019-06-10 33/week @ 2019-06-17 69/week @ 2019-06-24 49/week @ 2019-07-01 63/week @ 2019-07-08 1/week @ 2019-07-15 22/week @ 2019-07-22 10/week @ 2019-07-29 24/week @ 2019-08-05 2/week @ 2019-08-12 3/week @ 2019-08-19 49/week @ 2019-08-26

309 downloads per month
Used in 1 crate

MIT OR GPL-3.0+

1.5MB
26K SLoC

Tox

Travis Build Status Appveyor Build Status Coverage Status Docs Current Crates.io Version Join Gitter

This library is an implementation of toxcore in Rust - P2P, distributed, encrypted, easy to use DHT-based network.

Reference

The Tox Reference should be used for implementing toxcore in Rust. Reference source repository.

If existing documentation appears to not be complete, or is not clear enough, issue / pull request should be filled on the reference repository.

Contributions

...are welcome. 😄 For details, look at CONTRIBUTING.md.

Building

Fairly simple. First, install Rust >= 1.31.0 and a C compiler (Build Tools for Visual Studio on Windows, GCC or Clang on other platforms).

Then you can build the debug version with

cargo build

To run tests, use:

cargo test

To build docs and open them in your browser:

cargo doc --open

With clippy

To check for clippy warnings (linting), you need nightly Rust with clippy-preview component.

To check:

cargo clippy --all

To check with tests:

cargo clippy --all --tests

Goals

  • improved toxcore implementation in Rust
  • Rust API
  • documentation
  • tests
  • more

Progress

A fully working tox-node written in pure Rust with a DHT server and a TCP relay can be found here.

Right now we are working on the client part.

Authors

zetox was created by Zetok Zalbavar (zetok/openmailbox/org) and assimilated by the tox-rs team.

tox-rs has contributions from many users. See AUTHORS.md. Thanks everyone!

tox-rs is sponsored by Zerho LLC.

License

Dual licensed under the MIT or GPLv3+ licenses. You may use this project under the terms of either the MIT License or the GNU General Public License (GPL) Version 3+.

For details, see LICENSE-MIT and LICENSE-GPL.

Dependencies

~12MB
~107K SLoC