README.md 3.39 KB
Newer Older
Andrea Schaefer's avatar
Andrea Schaefer committed
1 2
# Chatty

3
A libpurple messaging client
Andrea Schaefer's avatar
Andrea Schaefer committed
4 5 6 7 8 9


## Build and install

### Install dependencies

10 11
On a Debian based system run

Andrea Schaefer's avatar
Andrea Schaefer committed
12
``` bash
13 14
    sudo apt-get -y install build-essential
    sudo apt-get -y build-dep .
Andrea Schaefer's avatar
Andrea Schaefer committed
15 16
```

17 18 19 20
For an explicit list of dependencies check the Build-Depends entry in the
[debian/control](https://source.puri.sm/Librem5/chatty/blob/master/debian/control#5)
file.

21
Libhandy (libhandy-1-dev) is available in [PureOS][0] and  Debian's
22 23 24
[experimental distribution][1].  If you don't want to fetch it from there you
can [build it from souce][2].

25 26
### Build and install the SMS plugin
``` bash
27
git clone git@source.puri.sm:Librem5/purple-mm-sms.git
28
cd purple-mm-sms
29 30 31
make
make install
```
32

Andrea Schaefer's avatar
Andrea Schaefer committed
33 34
This can be skipped if SMS support is not needed.

35 36 37 38 39 40 41 42 43 44
### Build and install the 'carbons' plugin
Message synchronization between devices according to XEP-0280

``` bash
git clone https://github.com/gkdr/carbons.git
cd carbons
make
make install
```

45
### Build and install the 'lurch' plugin
46
Please go to the git page where you'll find information on how to build and use the
47
[lurch OMEMO plugin](https://github.com/gkdr/lurch)
48

49 50
This can be skipped if encrypted messaging is not needed.

51 52

### Build and install the 'purple-matrix' plugin
53 54
Please go to the git page where you'll find information on how to build and install the
[Matrix messenger plugin](https://github.com/matrix-org/purple-matrix)
55

56 57 58 59 60 61 62 63
This can be skipped if Matrix messaging is not needed.


### Build and install the 'purple-telegram' plugin
Please go to the git page where you'll find information on how to build and install the
[Telegram messenger plugin](https://github.com/majn/telegram-purple)

This can be skipped if Telegram messaging is not needed.
64 65


Guido Gunther's avatar
Guido Gunther committed
66 67 68 69 70
### Build and install 'libfeedback'
Please go to the git page where you'll find information on how to build and use
[Feedbackd and libfeedback](https://source.puri.sm/Librem5/feedbackd)


71
### Build Chatty
Andrea Schaefer's avatar
Andrea Schaefer committed
72 73 74 75
``` bash
meson build
ninja -C build
```
76

77 78 79 80 81 82 83
## Running from the source tree
To run Chatty from source tree (without installing) do:

``` bash
build/run
```

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
## Commands

In a messaging conversation (except SMS conversations) the following commands can be used:

### lurch plugin

- '/lurch help': Displays a list with available commands.
- '/lurch uninstall': Uninstalls this device from OMEMO by removing its device ID from the devicelist.
- '/lurch blacklist add': Adds conversation partner to blacklist.
- '/lurch blacklist remove': Removes conversation partner from blacklist.
- '/lurch show id own': Displays this device's ID.
- '/lurch show id list': Displays this account's devicelist.
- '/lurch show fp own': Displays this device's key fingerprint.
- '/lurch show fp conv': Displays the fingerprints of all participating devices.
- '/lurch remove id <id>': Removes a device ID from the own devicelist.


### purple-mm-sms plugin

- '/mm-sms help': Displays a list with available commands.
- '/mm-sms status': Show modem status.


## XMPP account

If you don't have an XMPP account yet and want to subscribe to a service then please make sure that the server supports the following XEPs:

- XEP-0237: Roster Versioning
- XEP-0198: Stream Management
- XEP-0280: Message Carbons
- XEP-0352: Client State Indication
- XEP-0313: Message Archive Management
- XEP-0363: HTTP File Upload

118 119
[0]: http://software.pureos.net/search_pkg?term=libhandy-1-dev
[1]: https://packages.debian.org/search?keywords=libhandy-1-dev
120
[2]: https://source.puri.sm/Librem5/libhandy