Antidote/README.md

89 lines
3.5 KiB
Markdown

# Reboot of the Tox Messenger for the IPhone
<img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/Antidote/appstore.png" width=100>&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/Antidote/old_antidote_logo_with_text.png" width=100>
[Tox](https://tox.chat/) client for iOS
[![Release](https://img.shields.io/github/v/release/Zoxcore/Antidote.svg)](https://github.com/Zoxcore/Antidote/releases/latest/)
[![Translations](https://hosted.weblate.org/widgets/antidote/-/svg-badge.svg)](https://hosted.weblate.org/engage/antidote/)
[![License: GPL v3](https://img.shields.io/badge/License-MPL_2.0-blue.svg)](https://opensource.org/licenses/MPL-2.0)
[![Android CI](https://github.com/Zoxcore/Antidote/workflows/Nightly/badge.svg)](https://github.com/Zoxcore/Antidote/actions?query=workflow%3A%22Nightly%22)
[![Android CI](https://github.com/Zoxcore/Antidote/workflows/PullRequest/badge.svg)](https://github.com/Zoxcore/Antidote/actions?query=workflow%3A%22PullRequest%22)
<a href="https://apps.apple.com/app/antidote-tox-client/id1592895292"><img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/docs/appstore-badge.png" width="200"></a>
## FAQ
See [FAQ](FAQ/en.md).
<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/app001.png" height="200px">&nbsp;<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/app003.png" height="200px">&nbsp;<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/app004.png" height="200px">&nbsp;<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/app002.png" height="200px">&nbsp;<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/applewatch_push.jpg" height="200px">
## Help Translate the App in your Language
Use Weblate:
https://hosted.weblate.org/engage/antidote/
## Usage
#### Install from the App Store
* <a href="https://apps.apple.com/app/antidote-tox-client/id1592895292">Antidote - Tox Client</a><br>
#### Manual Installation
Clone repo, install pods and open `Antidote.xcworkspace` file with Xcode 12+.
```
git clone https://git.plastiras.org/Tha_14/Antidote/.git
cd Antidote
pod install
open Antidote.xcworkspace
```
#### Compile on the Commandline
Clone repo, install pods and install Xcode 12+
```
git clone https://git.plastiras.org/Tha_14/Antidote/.git
cd Antidote
pod install
env NSUnbufferedIO=YES xcodebuild -workspace ./Antidote.xcworkspace -scheme Antidote -destination 'platform=iOS Simulator,id=EAB9614F-3485-4A6D-8EFB-FC2B5EFB0243'
```
## Features
See [CHANGELOG](CHANGELOG.md) for list of notable changes (unreleased, current and previous versions).
- one to one conversations
- typing notifications
- emoticons
- spell checking
- reading/scanning Tox ID via QR code
- file transfers
- read receipts
- multiple profiles
- tox_save import/export
- avatars
- audio calls
- video calls
### Not implemented yet features:
- Service to wake up antidote through push notifications every x minutes
- Add confirmation dialogue before sending files
- Options in settings under advanced to set a socks5 proxy
- Option under advanced to change the NoSpam(manual and a randomize button options)
- Introduction modal when creating and signing in with a new profiles
- A confirmation popup upon deleting multiple items at once
## License
Antidote is available under Mozilla Public License Version 2.0. See the [LICENSE](LICENSE) file for more info.
## Links
- [icons8](http://icons8.com/) - icons used in app
- new icon https://icons8.com/icon/jQvC2IpxYkR6/key