transpub/USAGE.md

74 lines
2.4 KiB
Markdown
Raw Normal View History

2015-12-03 12:23:24 +00:00
# Usage
2015-12-03 20:12:32 +00:00
## Starting/stopping service
The `transwhat.py` script gets started as a backend by Spectrum. You should not try to run it manually.
To simplify the management of multiple transports (WhatsApp, IRC, Facebook, libpurple, ...), Spectrum provides a little helper tool called `spectrum_manager`:
2015-12-03 20:12:32 +00:00
To start transwhat run
```
spectrum_manager start whatsapp
```
To stop transwhat run
```
spectrum_manager stop whatsapp
```
2015-12-03 12:23:24 +00:00
## Bot
You might want to talk to bot if you're feeling lonely ;-P
The bot is one of the contacts every user has in its contact list. It offers you a simple way to interact with the server:
2015-12-03 12:44:13 +00:00
| **Command** | **Description** |
| ------------ | --------------- |
| `\help` | show this message |
| `\prune` | clear your buddylist |
| `\sync` | sync your imported contacts with WhatsApp |
| `\lastseen` | request last online timestamp from buddy |
| `\leave` | permanently leave group chat |
| `\groups` | print all attended groups |
| `\getgroups` | get current groups from WA |
2015-12-03 12:23:24 +00:00
<note tip>All commands start with a **back**slash!</note>
## Login
To login to the transWhat, you should use the service discovery option in your XMPP client.
When asked about the login credentials, enter your data as described below:
| **Setting** | **Value** | **Example** |
| ----------- | ------------------------- | --------------- |
| User | CountryCode + PhoneNumber | 4917634911387 |
2015-12-03 20:12:32 +00:00
| Password | WhatsApp password | [*Base64 string*](https://github.com/davidgfnet/whatsapp-purple#how-do-i-get-my-user-name-and-password)|
2015-12-03 12:23:24 +00:00
### Buddies
WhatsApp does not store your contacts on their servers. Thus you need to import your contacts manually with your XMPP Client or use [[.:bot|our bot]] to Import your contacts from Google (preferred).
(In Pidgin: Menu => Buddys => Add Buddy)
Just use the same JID format as for your login:
CountryCode + PhoneNumber + "@whatsapp.example.org"
### Groups
To chat with groups you need to add them manually to your XMPP client.
2015-12-03 12:34:00 +00:00
To get a list of your WhatsApp groups, you can use the Auto Discovery functionality of your XMPP client.
2015-12-03 12:23:24 +00:00
(In Pidgin: Menu => Buddys => Join Chat => RoomList)
### Smileys / Emojis
To be able to see smileys, you will need an [Unicode Emoji font](https://github.com/stv0g/unicode-emoji/raw/master/symbola/Symbola.ttf).
2015-12-03 12:23:24 +00:00
When using Pidgin, you might want to check out my [stv0g's Unicode emoji theme](https://github.com/stv0g/unicode-emoji)].