Blame view

README.md 6.03 KB
1a07012f   Matti Virkkunen   Add a warning abo...
1
2
3
4
5
6
7
8
9
  # WARNING: Line Corporation is currently banning people for using 3rd party clients
  
  There are multiple reports of accounts being permanently banned for using 3rd party clients such
  as Pidgin. What exactly triggers the ban is unknown, but it's probably best to stick to the
  official clients now.
  
  For this reason I've broken the build on purpose. If you still want to test purple-line, you
  should be able to figure out how to fix it yourself. Use at your own risk.
  
20733774   Matti Virkkunen   Initial commit - ...
10
11
12
  purple-line
  ===========
  
963524c5   Matti Virkkunen   Even more readme ...
13
14
  libpurple (Pidgin, Finch) protocol plugin for [LINE](http://line.me/).
  
963524c5   Matti Virkkunen   Even more readme ...
15
  ![Screenshot](http://i.imgur.com/By1yLXB.png)
dc8f9a72   Matti Virkkunen   Log in and get pr...
16
  
80e9cd7b   Matti Virkkunen   Include installat...
17
18
  Install via package manager (Ubuntu/Debian)
  -------------------------------------------
bbb5d0b2   Matti Virkkunen   Added note about ...
19
  
80e9cd7b   Matti Virkkunen   Include installat...
20
21
22
  An APT repository is available for installing the plugin. The repository contains the purple-line
  package itself, and the required Apache Thrift packages which are not properly packaged by either
  distribution.
bbb5d0b2   Matti Virkkunen   Added note about ...
23
  
80e9cd7b   Matti Virkkunen   Include installat...
24
25
  * http://debian.altrepo.eu/ (main)
  * http://debian.surlinter.net/ (mirror)
1fe49a82   Matti Virkkunen   Update readme abo...
26
  
5b539a52   Matti Virkkunen   README readabilit...
27
28
  The mirror is also available via SSL for secure access by using a **https://** url.
  
acc750ed   Matti Virkkunen   Include instructi...
29
30
  For instructions for adding a custom repository on Ubuntu, see
  [the Ubuntu wiki](https://help.ubuntu.com/community/Repositories/Ubuntu).
a9d806a5   Matti Virkkunen   Removed included ...
31
  
80e9cd7b   Matti Virkkunen   Include installat...
32
33
  For Debian, see [the Debian wiki](https://www.debian.org/releases/), or just add the following line
  to your `sources.list` file:
a9d806a5   Matti Virkkunen   Removed included ...
34
  
22d38642   matyapiro31   Add Windows expla...
35
  <pre><code>deb http://debian.altrepo.eu/ <b>code_name</b> main</code></pre>
791897e3   Matti Virkkunen   Fix readme and URL
36
  
22d38642   matyapiro31   Add Windows expla...
37
  Replace **code_name** with your distribution specific codename. The codenames are listed in the
76292b28   matyapiro31   Update README
38
  [debian.altrepo.eu wiki](http://altrepo.eu/git/debian.altrepo.eu/wikis/home#note).
acc750ed   Matti Virkkunen   Include instructi...
39
40
41
42
43
44
45
46
  In order to validate package signatures you need to add
  [this public key](http://debian.altrepo.eu/altrepo_eu.pub) to the APT key list. It can be done
  using the following command:
  
      wget -qO - http://debian.altrepo.eu/altrepo_eu.pub | sudo apt-key add -
  
  On either distribution, after adding the repository and key, run the following commands to install
  the plugin:
1fe49a82   Matti Virkkunen   Update readme abo...
47
  
80e9cd7b   Matti Virkkunen   Include installat...
48
49
      sudo apt-get update
      sudo apt-get install purple-line
c5625f6d   Matti Virkkunen   Add makefile opti...
50
  
76292b28   matyapiro31   Update README
51
52
53
  Install from source (Ubuntu/Debian)
  -----------------------------------
  
5e0b8b78   Matti Virkkunen   Clarify Debian/Ub...
54
  apt-build enables you to install from source easily. You need to add a source entry to
22d38642   matyapiro31   Add Windows expla...
55
  /etc/apt/sources.list. Run the following commands to install from source:
5b539a52   Matti Virkkunen   README readabilit...
56
  
22d38642   matyapiro31   Add Windows expla...
57
58
59
60
61
62
  <pre><code>sudo apt-get install apt-build
  echo "deb-src http://debian.altrepo.eu/ <b>code_name</b> main" | sudo tee -a /etc/apt/sources.list
  echo "deb http://debian.altrepo.eu/ <b>code_name</b> main" | sudo tee -a /etc/apt/sources.list
  sudo apt-get update
  sudo apt-build install purple-line
  </code></pre>
5b539a52   Matti Virkkunen   README readabilit...
63
  
22d38642   matyapiro31   Add Windows expla...
64
  Note that apt-build is **not** an official APT family program. If you install via source, your
5e0b8b78   Matti Virkkunen   Clarify Debian/Ub...
65
66
67
  purple-line version will be up to date with the git repository. Note that the current git version
  may not have been tested on Ubuntu/Debian. The package will install known build dependencies, but if
  the git version requires new dependencies, compilation will fail.
76292b28   matyapiro31   Update README
68
  
80e9cd7b   Matti Virkkunen   Include installat...
69
70
  Install from source (Arch Linux)
  --------------------------------
c5625f6d   Matti Virkkunen   Add makefile opti...
71
  
93a01923   Matti Virkkunen   Typo fix + clarif...
72
73
  Arch Linux packages all the required dependencies and there's a PKGBUILD available (not yet in AUR).
  You can install the plugin by simply typing:
4e72e62d   Matti Virkkunen   Add real install/...
74
  
93a01923   Matti Virkkunen   Typo fix + clarif...
75
      sudo pacman -S base-devel
5320862b   matyapiro31   Add new Arch Linu...
76
      curl -O http://altrepo.eu/git/arch.altrepo.eu/raw/master/purple-line/PKGBUILD
22d38642   matyapiro31   Add Windows expla...
77
      makepkg -cis
c5625f6d   Matti Virkkunen   Add makefile opti...
78
  
80e9cd7b   Matti Virkkunen   Include installat...
79
80
81
82
  Install from source (any distribution)
  --------------------------------------
  
  Make sure you have the required prerequisites installed:
c5625f6d   Matti Virkkunen   Add makefile opti...
83
  
80e9cd7b   Matti Virkkunen   Include installat...
84
  * libpurple - Library that provides the core functionality of Pidgin and other compatible clients.
86412402   Matti Virkkunen   Implement RSA log...
85
    Probably available from your package manager.
80e9cd7b   Matti Virkkunen   Include installat...
86
87
  * thrift - Apache Thrift compiler. May be available from your package manager.
  * libthrift - Apache Thrift C++ library. May be available from your package manager.
86412402   Matti Virkkunen   Implement RSA log...
88
  * libgcrypt - Crypto library. Probably available from your package manager.
80e9cd7b   Matti Virkkunen   Include installat...
89
90
  
  To install the plugin system-wide, run:
c5625f6d   Matti Virkkunen   Add makefile opti...
91
  
80e9cd7b   Matti Virkkunen   Include installat...
92
93
      make
      sudo make install
4e72e62d   Matti Virkkunen   Add real install/...
94
  
80e9cd7b   Matti Virkkunen   Include installat...
95
96
97
98
99
  The makefile supports a flag THRIFT_STATIC=true which causes it to download and build a version of
  Thrift and statically link it. This should be convenient for people using one of the numerous
  distributions that do not package Thrift.
  
  You can also install the plugin for your user only by replacing `install` with `user-install`.
1fe49a82   Matti Virkkunen   Update readme abo...
100
  
22d38642   matyapiro31   Add Windows expla...
101
102
103
  Install on Windows
  ------------------
  
5b539a52   Matti Virkkunen   README readabilit...
104
  Pre-built binaries for Windows are available at [Eion Robb's website](http://eion.robbmob.com/line/).
22d38642   matyapiro31   Add Windows expla...
105
  
5b539a52   Matti Virkkunen   README readabilit...
106
107
  If you want to use purple-line with Pidgin or Finch, copy libline.dll into `C:\Program Files (x86)\Pidgin\plugins\`
  and libgcrypt-20.dll & libgpg-error-0.dll into `C:\Program Files (x86)\Pidgin\`.
22d38642   matyapiro31   Add Windows expla...
108
  
80e9cd7b   Matti Virkkunen   Include installat...
109
110
  Features implemented
  --------------------
f7bd89a8   Matti Virkkunen   Implemented text ...
111
112
  
  * Logging in
f1b84fd6   Matti Virkkunen   Updated to-do
113
114
115
116
117
118
119
    * Authentication
    * Fetching user profile
    * Account icon
    * Syncing friends, groups and chats
  * Send and receive messages in IM, groups and chats
  * Fetch recent messages
    * For groups and chats
87e4db97   Matti Virkkunen   Fetch recent mess...
120
    * For IMs
97e535e4   Matti Virkkunen   Updated to-do
121
  * Synchronize buddy list on the fly
f1b84fd6   Matti Virkkunen   Updated to-do
122
123
    * Adding friends
    * Blocking friends
693a74ec   Matti Virkkunen   Implemented delet...
124
    * Removing friends
239fea72   Matti Virkkunen   Implemented synci...
125
    * Joining chats
f1b84fd6   Matti Virkkunen   Updated to-do
126
    * Leaving chats
77491f0e   Matti Virkkunen   Update TODO
127
    * Group invitations
239fea72   Matti Virkkunen   Implemented synci...
128
129
    * Joining groups
    * Leaving groups
97e535e4   Matti Virkkunen   Updated to-do
130
  * Buddy icons
e0ce79cf   Matti Virkkunen   TODO update
131
132
133
134
  * Editing buddy list
   * Removing friends
   * Leaving chats
   * Leaving groups
049c36bf   Matti Virkkunen   TODO update
135
136
  * Message types
   * Text (send/receive)
82987920   Matti Virkkunen   Implemented sendi...
137
   * Sticker (send via command/receive)
0fa93df6   Matti Virkkunen   Added support for...
138
139
   * Image (send/receive)
   * Audio (send/receive)
025aed6e   Matti Virkkunen   Display location ...
140
   * Location (receive)
f7bd89a8   Matti Virkkunen   Implemented text ...
141
  
80e9cd7b   Matti Virkkunen   Include installat...
142
143
  Features not yet implemented
  ----------------------------
f7bd89a8   Matti Virkkunen   Implemented text ...
144
  
87e4db97   Matti Virkkunen   Fetch recent mess...
145
  * Only fetch unseen messages, let a log plugin handle already seen messages
348be4bd   Matti Virkkunen   Added better reco...
146
  * Implement timeouts for faster reconnections
f1b84fd6   Matti Virkkunen   Updated to-do
147
  * Synchronize buddy list on the fly
239fea72   Matti Virkkunen   Implemented synci...
148
    * Sync group/chat users more gracefully, show people joining/leaving
f1b84fd6   Matti Virkkunen   Updated to-do
149
150
  * Editing buddy list
    * Adding friends (needs search function)
e0ce79cf   Matti Virkkunen   TODO update
151
152
    * Creating chats
    * Inviting people to chats
f1b84fd6   Matti Virkkunen   Updated to-do
153
154
155
    * Creating groups
    * Updating groups
    * Inviting people to groups
f1b84fd6   Matti Virkkunen   Updated to-do
156
  * Changing your account icon
049c36bf   Matti Virkkunen   TODO update
157
  * Message types
82987920   Matti Virkkunen   Implemented sendi...
158
    * Audio/Video (send) File transfer API for sending?
049c36bf   Matti Virkkunen   TODO update
159
    * Figure out what the other 15 message types mean...
93706fc9   Matti Virkkunen   Refactored Thrift...
160
  * Emoji (is it possible to tap into the smiley system for sending too?)
f1b84fd6   Matti Virkkunen   Updated to-do
161
  * Companion Pidgin plugin
dd67d8af   Matti Virkkunen   More TODOs
162
    * "Show more history" button
049c36bf   Matti Virkkunen   TODO update
163
    * Sticker list
82987920   Matti Virkkunen   Implemented sendi...
164
165
166
    * Open image messages
    * Open audio messages
    * Open video messages
98c73d7b   Matti Virkkunen   Added reconnectio...
167
  * Sending/receiving "message read" notifications
f1b84fd6   Matti Virkkunen   Updated to-do
168
  * Check builds on more platforms
1a07012f   Matti Virkkunen   Add a warning abo...
169
  * Packaging