1 | = Skype plugin for BitlBee |
---|
2 | Miklos Vajna <vmiklos@vmiklos.hu> |
---|
3 | |
---|
4 | == Status |
---|
5 | |
---|
6 | [Wilmer van der Gaast (author of BitlBee)] |
---|
7 | ____ |
---|
8 | Okay, this exists now, with lots of thanks to vmiklos for his *excellent* |
---|
9 | work!! |
---|
10 | |
---|
11 | It's not in the main BitlBee and it'll never be for various reasons, but |
---|
12 | because it's a plugin that shouldn't be a problem. |
---|
13 | ____ |
---|
14 | |
---|
15 | One day I browsed the BitlBee bugtracker and found |
---|
16 | http://bugs.bitlbee.org/bitlbee/ticket/82[this] ticket. Then after a while I |
---|
17 | returned and saw that it was still open. So I wrote it. |
---|
18 | |
---|
19 | It's pretty stable, I use it for my daily work. Being a plug-in, you patching |
---|
20 | is required, you can just install it after installing BitlBee itself. |
---|
21 | |
---|
22 | NOTE: You will see that this implementation of the Skype plug-in still requires |
---|
23 | a Skype instance to be running. This is because I'm not motivated to reverse |
---|
24 | engineer Skype's |
---|
25 | http://en.wikipedia.org/wiki/Skype_Protocol#Obfuscation_Layer[obfuscation |
---|
26 | layer]. (Not mentioning that you should ask your lawyer about if it is legal or |
---|
27 | not..) |
---|
28 | |
---|
29 | == Requirements |
---|
30 | |
---|
31 | * Skype >= 1.4.0.99. (1.4.0.74 did not work for me, 1.4.0.118 seems to be OK.) |
---|
32 | * bitlbee 1.1.1dev. (This is the latest version I've tested, probably |
---|
33 | newer versions probably will work, too.) |
---|
34 | * Skype4Py >= 0.9.28.1. Previous versions uses `DBus` by default. The latest version I've tested is 0.9.28.3. |
---|
35 | * Python 2.5. Skype4Py does not work with 2.4. |
---|
36 | * pygobject |
---|
37 | |
---|
38 | `bitlbee-skype` has been tested under Linux and Windows. Skype is available |
---|
39 | under OSX, too, so it probably works, but this has not been tested. |
---|
40 | |
---|
41 | == How to set it up |
---|
42 | |
---|
43 | Before you start. The setup is the following: BitlBee can't connect directly to |
---|
44 | Skype servers (the company's ones). It needs a running Skype client to do so. |
---|
45 | In fact BitlBee will connect to `skyped` (a tcp server, provided in this |
---|
46 | package) and `skyped` will connect to to your Skype client. |
---|
47 | |
---|
48 | NOTE: The order is important. First you have to start Skype. Then `skyped` can |
---|
49 | connect to it, finally BitlBee can connect to `skyped`. (In fact `skyped` |
---|
50 | automatically reconnect if you restart Skype.) |
---|
51 | |
---|
52 | - If you happen to be a happy Frugalware user, you can install the `bitlbee` |
---|
53 | and `bitlbee-skype` packages from |
---|
54 | http://ftp.frugalware.org/pub/other/people/vmiklos/bmf/[my repo]. |
---|
55 | |
---|
56 | - You need the BitlBee testing/development version: |
---|
57 | |
---|
58 | ---- |
---|
59 | wget http://get.bitlbee.org/src/bitlbee-1.1.1dev.tar.gz |
---|
60 | tar xf bitlbee-1.1.1dev.tar.gz |
---|
61 | cd bitlbee-1.1.1dev |
---|
62 | ---- |
---|
63 | |
---|
64 | NOTE: You no longer need additional patches, as of version 1.1.1dev. |
---|
65 | |
---|
66 | - Now compile and install it: |
---|
67 | |
---|
68 | ---- |
---|
69 | ./configure |
---|
70 | make |
---|
71 | make install install-dev |
---|
72 | ---- |
---|
73 | |
---|
74 | - Get the plugin code: |
---|
75 | |
---|
76 | ---- |
---|
77 | git clone git://vmiklos.hu/~vmiklos/bitlbee-skype |
---|
78 | ---- |
---|
79 | |
---|
80 | (Or you can use the tarballs below, see the Changelog about what |
---|
81 | features/bugfixes will you miss in this case). |
---|
82 | |
---|
83 | - Compile and install it: |
---|
84 | |
---|
85 | ---- |
---|
86 | make prepare |
---|
87 | ./configure |
---|
88 | make |
---|
89 | make install |
---|
90 | ---- |
---|
91 | |
---|
92 | - Install http://skype4py.sourceforge.net/[Skype4Py]. |
---|
93 | |
---|
94 | (You may remember that previous versions of `skyped` did not require this |
---|
95 | package. This because it now uses the X11 interface of Skype (because the |
---|
96 | previously used `DBus` interface had |
---|
97 | http://forum.skype.com/index.php?s=&showtopic=94545&view=findpost&p=431710[known |
---|
98 | problems]), but I wanted to prevent a large code duplication from that project. |
---|
99 | In addition it then no longer requires the `dbus-python` package, just |
---|
100 | `pygobject`.) |
---|
101 | |
---|
102 | - Start Skype and `skyped` (the tcp server): |
---|
103 | |
---|
104 | ---- |
---|
105 | skype |
---|
106 | skyped |
---|
107 | ---- |
---|
108 | |
---|
109 | NOTE: It's important to start `skyped` on the same machine and using the same |
---|
110 | user! |
---|
111 | |
---|
112 | - Start your `IRC` client, connect to BitlBee and add your account: |
---|
113 | |
---|
114 | ---- |
---|
115 | account add skype <user> <pass> |
---|
116 | account set 0/server localhost |
---|
117 | ---- |
---|
118 | |
---|
119 | IMPORTANT: <user> should be your Skype account name. This way you won't see |
---|
120 | yourself joining to `&bitlbee`. |
---|
121 | |
---|
122 | NOTE: the <pass> option is not used currently. |
---|
123 | |
---|
124 | == Setting up Skype in a VNC server (optional) |
---|
125 | |
---|
126 | Optionally, if you want to run Skype on a server, you might want to setup up |
---|
127 | a `VNC` server as well. I used `tightvnc` but probably other `VNC` servers will |
---|
128 | work, too. |
---|
129 | |
---|
130 | First run |
---|
131 | |
---|
132 | ---- |
---|
133 | vncpasswd ~/.vnc/passwd |
---|
134 | ---- |
---|
135 | |
---|
136 | and create a password. You will need it at least once. |
---|
137 | |
---|
138 | Now create `~/.vnc/xstartup` with the following contents: |
---|
139 | |
---|
140 | ---- |
---|
141 | #!/bin/sh |
---|
142 | |
---|
143 | sleep 1 |
---|
144 | skype & |
---|
145 | sleep 5 |
---|
146 | skyped |
---|
147 | ---- |
---|
148 | |
---|
149 | Adjust the permissions: |
---|
150 | |
---|
151 | ---- |
---|
152 | chmod +x ~/.vnc/xstartup |
---|
153 | ---- |
---|
154 | |
---|
155 | Then start the server: |
---|
156 | |
---|
157 | ---- |
---|
158 | vncserver |
---|
159 | ---- |
---|
160 | |
---|
161 | Then connect to it, and set up Skype (username, password, enable auto-login, and |
---|
162 | allow the `SkypeApiPythonShell` client when Skype asks about it). |
---|
163 | |
---|
164 | Please be aware about that Skype has serious memory leak issues. After running |
---|
165 | with for a few weeks it may eat >300 MB of memory. Just don't forget to restart |
---|
166 | your VNC server regularly. (How ugly.) |
---|
167 | |
---|
168 | == What works |
---|
169 | |
---|
170 | - Download nicks and away statuses from Skype |
---|
171 | |
---|
172 | - Noticing joins / parts while we're connected |
---|
173 | |
---|
174 | - Sending messages |
---|
175 | |
---|
176 | - Receiving messages |
---|
177 | |
---|
178 | - Receiving away status changes |
---|
179 | |
---|
180 | - `skyped` (the tcp daemon that is a gateway between Skype and tcp) |
---|
181 | |
---|
182 | - Error handling when `skyped` is not running and when it exits |
---|
183 | |
---|
184 | - Marking received messages as seen so that Skype won't say there are unread messages |
---|
185 | |
---|
186 | - Adding / removing contacts |
---|
187 | |
---|
188 | - Set away state when you do a `/away`. |
---|
189 | |
---|
190 | - When you `account off`, Skype will set status to `Offline` |
---|
191 | |
---|
192 | - When you `account on`, Skype will set status to `Online` |
---|
193 | |
---|
194 | - Detect when somebody wants to add you and ask for confirmation |
---|
195 | |
---|
196 | - Detect when somebody wants to transfer a file |
---|
197 | |
---|
198 | - Group chat support: |
---|
199 | |
---|
200 | * Detect if we're invited |
---|
201 | |
---|
202 | * Send / receive group chat messages |
---|
203 | |
---|
204 | * Invite others (using `/invite <nick>`) |
---|
205 | |
---|
206 | * Part from group chats |
---|
207 | |
---|
208 | * Starting a group chat (using `/j #nick`) |
---|
209 | |
---|
210 | - Topic changes in group chats: |
---|
211 | |
---|
212 | * Show the current topic (if any) on join |
---|
213 | |
---|
214 | * Notice when someone changes the topic |
---|
215 | |
---|
216 | * Support changing the topic using `/topic` |
---|
217 | |
---|
218 | == What needs to be done (aka. TODO) |
---|
219 | |
---|
220 | - Add a question callback for calls. |
---|
221 | |
---|
222 | - Notice if foo invites bar. Currently you can see only that bar joined. |
---|
223 | |
---|
224 | - Public chats. See link:http://forum.skype.com/index.php?showtopic=98872[this |
---|
225 | forum thread], it is still unclear how could it be done for you to be able to |
---|
226 | `/join` to a public chat.. |
---|
227 | |
---|
228 | == I would like to have support for ... |
---|
229 | |
---|
230 | If something does not work and it's not in the TODO section, then please |
---|
231 | contact me! Please also try the git version before reporting a bug, your |
---|
232 | problem may be already fixed there. |
---|
233 | |
---|
234 | In fact, of course, I wrote this documentation after figured out how to do this |
---|
235 | setup, so maybe I left out some steps. If you needed 'any' additional tricks, |
---|
236 | then it would be nice to include them here. |
---|
237 | |
---|
238 | == Known bugs |
---|
239 | |
---|
240 | - None at this time. |
---|
241 | |
---|
242 | == Screenshots |
---|
243 | |
---|
244 | You can reach some screenshots link:shot[here]. |
---|
245 | |
---|
246 | == Additional resources |
---|
247 | |
---|
248 | You can reach the Changelog link:Changelog[here], and a gitweb interface |
---|
249 | http://repo.or.cz/w/bitlbee-skype.git[here]. |
---|
250 | |
---|
251 | The Skype API documentation is |
---|
252 | https://developer.skype.com/Docs/ApiDoc[here] if you're interested. |
---|
253 | |
---|
254 | == Thanks |
---|
255 | |
---|
256 | for the following people: |
---|
257 | |
---|
258 | * Wilmer van der Gaast, for answering questions about the bitlbee plugin interface |
---|
259 | |
---|
260 | * Arkadiusz Wahlig, author of skype4py, for making suggestions to skyped |
---|
261 | |
---|
262 | * Gabor Adam TOTH, for usable bugreports |
---|
263 | |
---|
264 | Back to my link:/projects[projects page]. |
---|
265 | |
---|
266 | // vim: ft=asciidoc |
---|