StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

Update readme; I'm vain like that.

Browse Source
This commit is contained in:
NemDiggers 2013-07-18 22:32:28 -04:00
parent 60957885fd
commit 6c2b0e7815
1 changed files with 32 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -1,40 +1,34 @@
Tox
===
![Project Tox](https://rbt.asia/boards/g/img/0352/79/1373823047559.png "Project Tox")
Project Tox, _also known as Tox_, is a FOSS instant messaging application aimed to replace Skype.<br />
[![Build Status](https://travis-ci.org/irungentoo/ProjectTox-Core.png?branch=master)](https://travis-ci.org/irungentoo/ProjectTox-Core)
Current IRC: #InsertProjectNameHere
on Freenode or [webchat](https://webchat.freenode.net/)
With the rise of governmental monitoring programs, Tox aims to be an easy to use application that allows people to connect with friends and loved ones without the worry of privacy.<br /> <br />
Proposal of a free as in freedom skype replacement:
## Basics:
UDP must be used for everything simply because you can't do hole punching with TCP (well you can but it doesn't work all the time)
Every peer is represented as a byte string (the client id) (It is the public key of the peer.). (if you want to add someone you need that id (either ask that person directly or maybe through some kind of search engine?))
Use something torrent DHT style so that peers can find the ip of the other peers when they have their id.
Once the client has the ip of that peer they start initiating a secure connection with each other.(See Crypto.)
When both peers are securely connected with the encryption they can securely exchange messages, initiate a video chat, send files, etc...
Your client stores the public keys/id of the peers used to initiate the connection (this is your contacts list)
**IRC**: #InsertProjectNameHere on Freenode, alternatively, you can use the [webchat](https://webchat.freenode.net/).<br />
**Website**: [http://projecttox.org](http://projecttox.org)
## Geeky Stuff:
+ Tox must use UDP simply because you can't hole punch with TCP. It's possible, but it doesn't work all the time.
+ Every peer is represented as a byte string (the public key of the peer [client id])
+ We're using torrent-style DHT so that peers can find the IP of the other peers when they have their ID.
+ Once the client has the IP of that peer, they start initiating a secure connection with each other. (See [Crypto](https://github.com/irungentoo/ProjectTox-Core/blob/master/docs/Crypto.txt))
+ When both peers are securely connect with the encryption, they can securely exchange messages, initiate a video chat, send files, etc.
## Roadmap:
- [x] Get our DHT working perfectly.(Done, needs large scale testing though.)
- [x] Reliable connection (See Lossless_UDP protocol) to other peers according to client id. (Done, see DHT_sendfiletest.c for an example)
- [x] Encryption. (Done)
- [ ] Get a simple text only im client working perfectly. (This is where we are)
- [ ] Streaming media
- [ ] ???
1. Get our DHT working perfectly.(Done, needs large scale testing though.)
2. Reliable connection (See Lossless_UDP protocol) to other peers according to client id. (Done, see DHT_sendfiletest.c for an example)
3. Encryption. (Done)
4. Get a simple text only im client working perfectly. (This is where we are)
5. Streaming media
6.
For further information, check our [To-Do list](https://github.com/irungentoo/InsertProjectNameHere/blob/master/docs/TODO.txt).
## TODO:
See: [docs/TODO.txt](https://github.com/irungentoo/InsertProjectNameHere/blob/master/docs/TODO.txt)
### Important-stuff:
@ -42,18 +36,16 @@ Use the same UDP socket for everything
Keep everything really simple.
### Details:
### Details and Documents:
DHT protocol:
see: [docs/DHT.txt](/docs/DHT.txt)
Lossless UDP protocol:
Either we find one with an already working implementation (Didn't find a good implementation, writing my own)
see also: [docs/Lossless_UDP.txt](/docs/Lossless_UDP.txt)
Crypto:
see: [docs/Crypto.txt](/docs/Crypto.txt)
[DHT Protocol](/docs/DHT.txt)<br />
[Lossless UDP Protocol](/docs/Lossless_UDP.txt)<br />
[Crypto](/docs/Crypto.txt)<br />
[Ideas](/docs/IDEAS.txt)
### Why are you doing this? There are already a bunch of free skype alternatives.
see: [docs/WHY.txt](/docs/WHY.txt)
The goal of this project is to create a configuration free p2p skype
replacement. Configuration free means that the user will simply have to open the program and
without any account configuration will be capable of adding people to his
friends list and start conversing with them. There are many so called skype replacements and all of them are either hard to
configure for the normal user or suffer from being much too centralized.