toxygen/README.md

67 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2016-07-27 16:53:50 +02:00
# Toxygen
2016-08-30 19:23:55 +02:00
Toxygen is powerful cross-platform [Tox](https://tox.chat/) client written in pure Python3.
2016-03-16 17:06:15 +01:00
2016-08-01 21:07:01 +02:00
[![Release](https://img.shields.io/github/release/xveduk/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/releases/latest)
[![Stars](https://img.shields.io/github/stars/xveduk/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/stargazers)
[![Open issues](https://img.shields.io/github/issues/xveduk/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/issues)
[![License](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](https://raw.githubusercontent.com/toxygen-project/toxygen/master/LICENSE.md)
2016-08-05 21:44:01 +02:00
[![Build Status](https://travis-ci.org/toxygen-project/toxygen.svg?branch=master)](https://travis-ci.org/toxygen-project/toxygen)
2016-05-12 21:52:47 +02:00
2016-07-27 16:53:50 +02:00
### [Install](/docs/install.md) - [Contribute](/docs/contributing.md) - [Plugins](/docs/plugins.md) - [Compile](/docs/compile.md) - [Contact](/docs/contact.md)
2016-05-12 21:52:47 +02:00
2016-05-13 11:08:45 +02:00
### Supported OS:
2016-07-27 16:53:50 +02:00
2016-08-19 19:12:51 +02:00
![Linux, Windows and OS X](/docs/os.png)
2016-07-27 16:53:50 +02:00
2016-08-19 19:12:51 +02:00
### Features:
2016-03-29 20:19:29 +02:00
2016-03-16 17:06:15 +01:00
- [x] 1v1 messages
2016-04-27 20:10:53 +02:00
- [x] File transfers
- [x] Audio
2016-06-28 20:47:49 +02:00
- [x] Plugins support
2016-03-16 17:06:15 +01:00
- [x] Chat history
2016-06-28 20:47:49 +02:00
- [x] Emoticons
- [x] Stickers
2016-05-28 12:30:26 +02:00
- [x] Screenshots
- [x] Name lookups (toxme.io support)
2016-06-28 20:47:49 +02:00
- [x] Save file encryption
2016-05-28 12:30:26 +02:00
- [x] Profile import and export
2016-06-28 20:47:49 +02:00
- [x] Faux offline messaging
- [x] Faux offline file transfers
2016-04-27 20:10:53 +02:00
- [x] Inline images
2016-03-16 17:06:15 +01:00
- [x] Message splitting
- [x] Proxy support
2016-03-29 20:15:12 +02:00
- [x] Avatars
2016-04-04 14:05:06 +02:00
- [x] Multiprofile
- [x] Multilingual
2016-04-10 14:27:35 +02:00
- [x] Sound notifications
2016-04-27 20:10:53 +02:00
- [x] Contact aliases
- [x] Contact blocking
- [x] Typing notifications
- [x] Changing nospam
2016-05-12 21:52:47 +02:00
- [x] File resuming
2016-06-05 19:17:39 +02:00
- [x] Read receipts
2016-04-05 19:42:28 +02:00
- [ ] Video
- [ ] Desktop sharing
2016-06-28 20:47:49 +02:00
- [ ] Group chats
2016-03-16 17:06:15 +01:00
2016-07-27 16:53:50 +02:00
### Downloads
2016-08-01 21:07:01 +02:00
[Releases](https://github.com/toxygen-project/toxygen/releases)
2016-06-05 19:17:39 +02:00
2016-08-01 21:07:01 +02:00
[Download last stable version](https://github.com/toxygen-project/toxygen/archive/master.zip)
2016-04-13 23:46:28 +02:00
2016-08-01 21:07:01 +02:00
[Download develop version](https://github.com/toxygen-project/toxygen/archive/develop.zip)
2016-03-16 17:06:15 +01:00
2016-07-27 16:53:50 +02:00
### Screenshots
2016-05-12 21:52:47 +02:00
*Toxygen on Ubuntu and Windows*
2016-03-30 23:23:10 +02:00
![Ubuntu](/docs/ubuntu.png)
![Windows](/docs/windows.png)
2016-03-29 20:19:29 +02:00
2016-07-27 16:53:50 +02:00
### Docs
2016-03-16 17:06:15 +01:00
[Check /docs/ for more info](/docs/)
2016-08-18 18:08:12 +02:00
Also visit [pythonhosted.org/Toxygen/](http://pythonhosted.org/Toxygen/)
2016-08-19 19:12:51 +02:00
[Wiki](https://wiki.tox.chat/clients/toxygen)