Tox
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. :smile: 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
To run tests, use:
To build docs and open them in your browser:
With clippy
To check for clippy warnings
(linting), you need nightly Rust with clippy-preview
component.
To check:
To check with 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.