telegram-purple/README.md

154 lines
4.9 KiB
Markdown
Raw Permalink Normal View History

2014-10-02 17:11:42 +02:00
Telegram-Purple
2014-07-26 11:55:45 +02:00
===============
Telegram-purple is a Libpurple plugin that adds support for the Telegram messenger. Its still in an early (pre-alpha) development stage, but already provides basic chat functionality and group chats.
2014-07-26 11:55:45 +02:00
2014-10-02 17:11:42 +02:00
This plugin is based on [Telegram-cli](http://github.com/vysheng/tg), a full-featured terminal-based client for Telegram created by [Vysheng](http://github.com/vysheng).
2014-07-26 11:55:45 +02:00
# Changelog
2014-07-26 11:55:45 +02:00
Warning, this version is mainly for development and testing and NOT for productive use. Even though it already provides basic features, you should still expect bugs and crashes when running it.
2014-07-26 11:55:45 +02:00
2014-10-02 17:11:42 +02:00
When encountering a crash or some other bugs, please report it to us, preferably together with a backtrace of the crashed application [https://developer.pidgin.im/wiki/GetABacktrace]
2014-07-26 11:55:45 +02:00
## Version 0.3.1
- Improve error handling
- Fix some installation problems
## Version 0.3.0
- Provide Adium Plugin
# Features
2014-10-02 17:11:42 +02:00
## Already Implemented:
- Chats/Group-Chats
* Send/receive messages
* Discover buddies/chats
* Discover buddy state and info
- Profile Pictures
* Download and use profile pictures
2014-10-05 15:38:31 +02:00
- Adium Plugin
2014-10-02 17:11:42 +02:00
## TODO:
2014-07-26 11:55:45 +02:00
2014-09-20 18:31:04 +02:00
The following features are currently planned and will probably be added in the future:
- Encrypted chats
- Picture, audio and video messages
- File transfers
- Geo-locations
2014-10-02 17:11:42 +02:00
- Multiple accounts on one client
- Respect libpurple proxy settings (implemented but untested)
2014-09-20 18:31:04 +02:00
2014-07-26 11:55:45 +02:00
2014-10-02 17:11:42 +02:00
## Platform Support
2014-09-20 18:31:04 +02:00
2014-10-05 15:38:31 +02:00
We only provide an installation guide for Linux right now, even though it should be possible to compile this plugin on other platforms. If someone manages to create a working Windows or BSD-build please let us know.
2014-07-26 11:55:45 +02:00
# Installation Instructions
2014-07-26 11:55:45 +02:00
2014-10-04 12:19:43 +02:00
Unfortunately there are no packages right now, so you need to compile it yourself:
2014-07-26 11:55:45 +02:00
2014-10-04 12:19:43 +02:00
## 1. Get this repository
git clone https://github.com/majn/telegram-purple
2014-07-26 11:55:45 +02:00
2014-10-02 17:11:42 +02:00
## 2. Fetch all needed dependencies
2014-07-26 11:55:45 +02:00
2014-10-02 17:11:42 +02:00
This plugin depends on a working libpurple client (like Pidgin or Finch) and the following packages:
2014-07-26 11:55:45 +02:00
- glib-2.0
2014-10-02 17:11:42 +02:00
- libssl
- libpurple
- libzlib
2014-07-26 11:55:45 +02:00
2014-10-02 17:11:42 +02:00
### Fedora
2014-07-26 11:55:45 +02:00
On Fedora you can install all dependencies with:
2014-07-26 11:55:45 +02:00
sudo yum install gcc openssl-devel glib2-devel libpurple-devel
2014-07-26 11:55:45 +02:00
2014-10-02 17:11:42 +02:00
### Debian
2014-07-26 11:55:45 +02:00
2014-10-02 17:11:42 +02:00
On Debian-based systems you can use:
2014-07-26 11:55:45 +02:00
sudo apt-get install libssl-dev libglib2.0-dev libpurple-dev
2014-07-26 11:55:45 +02:00
2014-10-03 18:50:09 +02:00
NOTE: Ubuntu is currently not working, since libpurple doesn't seem to find libssl when loading the plugin. It will compile, but Pidgin won't be able to load it.
2014-10-02 23:10:45 +02:00
### OpenSUSE
sudo zypper install gcc glib glib-devel libpurple libpurple-devel zlib-devel openssl libopenssl-devel
2014-10-02 17:11:42 +02:00
## 3. Compile and install
2014-07-26 11:55:45 +02:00
make
sudo make install
2014-07-26 11:55:45 +02:00
# Usage
2014-07-26 11:55:45 +02:00
After succesfully completing all steps mentioned in the installation instructions, you should restart Pidgin to ensure that the plugin is loaded. When everything went well, Telegram should show up in the account manager:
2014-07-26 11:55:45 +02:00
2014-09-20 18:18:34 +02:00
![Create a new Telegram account](http://lauschgift.org/telegram-purple/res/install-1.png)
2014-07-26 11:55:45 +02:00
The username is your current phone number, including your full country prefix instead of a leading '0'. For Germany, this would be '+49' for example. Telegram will verify your phone number by sending you a verification code via sms. You will be prompted for this code, once that happens.
2014-07-26 11:55:45 +02:00
2014-09-20 18:18:34 +02:00
![Provide a phone number](http://lauschgift.org/telegram-purple/res/install-2.png)
Now you should be able to see all your contacts and chats in your buddy list and send/receive messages.
2014-07-26 11:55:45 +02:00
2014-10-03 18:42:25 +02:00
# Troubleshooting
If you encounter problems running this plugin and you have updated from an older version,
deleting your old user-data might be helpful. WARNING: This will require you to enter a new authentication
code and delete all your secret chat keys.
To clean all your user files run:
sudo make purge
2014-10-03 18:42:25 +02:00
2014-10-05 15:38:31 +02:00
# Adium Plugin
We will provide a readily build bundle soon, until then you can try to build the XCode-Project yourself if you want.
1. Compile your Adium-Version and point the Telegrm-Adium build settings to its build-output.
2. Get zlib and libcrypto.a and provide it somewhere in your build path.
3. Build the XCode-Project, click on
# Unicode Emojis for Pidgin
2014-10-05 15:38:31 +02:00
The Telegram phone applications for iOS and Android make use of standardized Unicode smileys (called [Emojis](https://en.wikipedia.org/wiki/Emoji)). Pidgin
does not display those smileys natively, but you can install a custom smiley theme like (https://github.com/stv0g/unicode-emoji) or (https://github.com/VxJasonxV/emoji-for-pidgin) and activate it under Settings > Themes > Smiley Theme.
# Authors
2014-10-05 15:38:31 +02:00
Telegram-Purple and Telegram-Adium were written by:
2014-10-05 15:38:31 +02:00
- Matthias Jentsch <mtthsjntsch@gmail.com>
- Christopher Althaus <althaus.christopher@gmail.com>
- Markus Endres <endresma45241@th-nuernberg.de>
The plugin is based on Telegram-CLI, which was written by Vitaly Valtman <mail@vysheng.ru> and others, see (http://github.com/vysheng/tg)