sands-client/README.md

72 lines
2.0 KiB
Markdown

# sands-client (a fork of I2P Chat AKA I2P Qt Messenger)
## Screenshots
TBD add
## Features
* The communication goes «directly over i2p» from client to client, no server is required.`[1]` Note: The connections to the so-called «seedless» servers were removed from this project.
## How to run it
You need to enable SAM in your router on <a href="http://127.0.0.1:7657/configclients">java i2p configclients page</a> or i2pd's `[sam]` config section at `i2pd.conf` to make I2P Chat work over your I2P router.
TBD make more user-friendly and include i2pd directly into the codebase of sands-client for better UX.
## Project news and history
### Current news
5 Jan, 2017: Original repo at http://git.repo.i2p/w/I2P-Messenger-QT.git was fully merged here.
### History
Original developer of this messenger went away.
## License
The license of this software is GPLv2.
### Build instructions
* Install prerequisites:
```
sudo apt-get install qt5-qmake qt5-default build-essential libqt5multimedia5 qtmultimedia5-dev
```
* Run qmake for either release:
```
qmake I2P-Messenger.pro "CONFIG += release"
```
or for debug:
```
qmake I2P-Messenger.pro "CONFIG += debug"
```
* And after that,
```
make -j NUMBER_OF_PROCESSOR_CORES
```
or simply
```
make
```
## Running
On Linux, `make` creates `I2P-Messenger` executable in the current folder. Run it with `./I2P-Messenger`. When ran, switch yourself to online. It will generate your Destination address (a key) on first connect to SAM.
## Old files and sites
* http://echelon.i2p/qti2pmessenger/macos → Mac OS X versions, not tested;
* http://echelon.i2p/qti2pmessenger/ → old eche|on's site for I2P Chat (versions up to 0.2.24);
* https://launchpad.net/~i2p.packages/+archive/ubuntu/i2p/+sourcepub/4824794/+listing-archive-extra → Kill Your TV's PPA (v.0.2.25).
* http://git.repo.i2p/w/I2P-Messenger-QT.git/shortlog → original repo (fully merged into this /i2pchat)
## Forum thread (English)
http://forum.i2p/viewtopic.php?t=2474
## Footnotes
`[1]` http://forum.i2p/viewtopic.php?p=11071#11071