source: skype/README @ 3878849

Last change on this file since 3878849 was 3878849, checked in by Miklos Vajna <vmiklos@…>, at 2008-02-28T23:53:04Z

remove item from TODO, fixed upstream

  • Property mode set to 100644
File size: 8.6 KB
Line 
1= Skype plugin for BitlBee
2Miklos Vajna <vmiklos@vmiklos.hu>
3
4== Status
5
6[Wilmer van der Gaast (author of BitlBee)]
7____
8Okay, this exists now, with lots of thanks to vmiklos for his *excellent*
9work!!
10
11It's not in the main BitlBee and it'll never be for various reasons, but
12because it's a plugin that shouldn't be a problem.
13____
14
15One day I browsed the BitlBee bugtracker and found
16http://bugs.bitlbee.org/bitlbee/ticket/82[this] ticket. Then after a while I
17returned and saw that it was still open. So I wrote it.
18
19It's pretty stable, I use it for my daily work. Being a plug-in, no patching
20is required, you can just install it after installing BitlBee itself.
21
22NOTE: You will see that this implementation of the Skype plug-in still requires
23a Skype instance to be running. This is because I'm not motivated to reverse
24engineer Skype's
25http://en.wikipedia.org/wiki/Skype_Protocol#Obfuscation_Layer[obfuscation
26layer]. (Not mentioning that you should ask your lawyer about if it is legal or
27not..)
28
29== Requirements
30
31* Skype >= 1.4.0.99. The latest version I've tested is 2.0.0.43.
32* BitlBee >= 1.1.1dev. This is the latest version I've tested, probably
33  newer versions will work, too.
34* Skype4Py >= 0.9.28.7. Previous versions won't work due to API changes.
35* Python >= 2.5. Skype4Py does not work with 2.4.
36* PyGObject >= 2.8.0. Older versions are part of PyGTK. (And you don't want to
37  install GTK for nothing, right?)
38
39`bitlbee-skype` has been tested under Linux and Windows. Skype and Skype4py is
40available under OSX, too, so it probably works, but this has not been tested.
41
42== How to set it up
43
44Before you start. The setup is the following: BitlBee can't connect directly to
45Skype servers (the company's ones). It needs a running Skype client to do so.
46In fact BitlBee will connect to `skyped` (a tcp server, provided in this
47package) and `skyped` will connect to to your Skype client.
48
49NOTE: The order is important. First `skyped` starts Skype. Then `skyped` can
50connect to Skype, finally BitlBee can connect to `skyped`.
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
64NOTE: 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$ wget http://vmiklos.hu/project/bitlbee-skype/bitlbee-skype-@VERSION@.tar.gz
78$ tar xf bitlbee-skype-@VERSION@.tar.gz
79$ cd bitlbee-skype-@VERSION@
80----
81
82It doesn't matter where do you get it, it'll install the plugin to `/usr/local`
83by default (that's the location where BitlBee searches for plugins by default).
84
85- Compile and install it:
86
87----
88$ ./configure
89$ make
90# make install
91----
92
93- Install http://skype4py.sourceforge.net/[Skype4Py].
94
95(You may remember that previous versions of `skyped` did not require this
96package. This because it now uses the X11 interface of Skype (because the
97previously used `DBus` interface had
98http://forum.skype.com/index.php?s=&showtopic=94545&view=findpost&p=431710[known
99problems]), but I wanted to prevent a large code duplication from that project.
100In addition it then no longer requires the `dbus-python` package, just
101`pygobject`.)
102
103- Edit `/usr/local/etc/skyped/skyped.conf`: adjust `username` and `password`. The
104  `username` should be your Skype login and the `password` can be whatever you
105  want, but you will have to specify that one when adding the Skype account to
106  BitlBee (see later).
107
108NOTE: Here, and later - `/usr/local/etc` can be different on your installation
109if you used the `--sysconfdir` switch when running bitlbee-skype's `configure`.
110
111- Generate the SSL pem files:
112
113----
114# cd /usr/local/etc/skyped
115# openssl req -new -x509 -days 365 -nodes -config skyped.cnf -out skyped.cert.pem \
116        -keyout skyped.key.pem
117----
118
119NOTE: Maybe you want to adjust the permissions in the `/usr/local/etc/skyped`
120dir. For example make it readable by just your user.
121
122- Start `skyped` (the tcp server):
123
124----
125$ skyped
126----
127
128- Start your `IRC` client, connect to BitlBee and add your account:
129
130----
131account add skype <user> <pass>
132account set skype/server localhost
133----
134
135<user> should be your Skype account name, <pass> should be the one you declared
136in `skyped.conf`. If you want to run skyped on a remote machine, replace
137`localhost` with the name of the machine.
138
139== Setting up Skype in a VNC server (optional)
140
141Optionally, if you want to run Skype on a server, you might want to setup up
142a `VNC` server as well. I used `tightvnc` but probably other `VNC` servers will
143work, too.
144
145First run
146
147----
148$ vncpasswd ~/.vnc/passwd
149----
150
151and create a password. You will need it at least once.
152
153Now create `~/.vnc/xstartup` with the following contents:
154
155----
156#!/bin/sh
157
158sleep 1
159skyped
160----
161
162Adjust the permissions:
163
164----
165$ chmod +x ~/.vnc/xstartup
166----
167
168Then start the server:
169
170----
171$ vncserver
172----
173
174Then connect to it, and set up Skype (username, password, enable auto-login, and
175allow the `SkypeApiPythonShell` client when Skype asks about it).
176
177Please be aware about that Skype has serious memory leak issues. After running
178with for a few weeks it may eat >300 MB of memory. Just don't forget to restart
179your VNC server regularly. (How ugly.)
180
181== What works
182
183- Download nicks and away statuses from Skype
184
185- Noticing joins / parts while we're connected
186
187- Sending messages
188
189- Receiving messages
190
191- Receiving away status changes
192
193- `skyped` (the tcp daemon that is a gateway between Skype and tcp)
194
195- Error handling when `skyped` is not running and when it exits
196
197- Marking received messages as seen so that Skype won't say there are unread messages
198
199- Adding / removing contacts
200
201- Set away state when you do a `/away`.
202
203- When you `account off`, Skype will set status to `Offline`
204
205- When you `account on`, Skype will set status to `Online`
206
207- Detect when somebody wants to add you and ask for confirmation
208
209- Detect when somebody wants to transfer a file
210
211- Group chat support:
212
213  * Detect if we're invited
214
215  * Send / receive group chat messages
216
217  * Invite others (using `/invite <nick>`)
218
219  * Part from group chats
220
221  * Starting a group chat (using `/j #nick`)
222
223- Topic changes in group chats:
224
225  * Show the current topic (if any) on join
226
227  * Notice when someone changes the topic
228
229  * Support changing the topic using `/topic`
230
231- Viewing the profile using the `info` command.
232
233- Handling skype actions (when the `CHATMESSAGE` has `EMOTED` type)
234
235- Setting your display name using the `nick` command.
236
237- Running Skype on a machine different to BitlBee is possible, the
238  communication is encrypted.
239
240== What needs to be done (aka. TODO)
241
242- Add support for accepting/rejecting and starting calls via settings. (Depends
243  on the previous fix.)
244
245- Notice if foo invites bar. Currently you can see only that bar joined.
246
247- Public chats. See link:http://forum.skype.com/index.php?showtopic=98872[this
248  forum thread], it is still unclear how could it be done for you to be able to
249  `/join` to a public chat..
250
251- Add `--disable-skyped` and `--disable-plugin` switches in case one wants to
252  build `bitlbee-skype` only for a public server or only for use with a public
253  server.
254
255== I would like to have support for ...
256
257If something does not work and it's not in the TODO section, then please
258contact me! Please also try the link:HACKING[git version] before reporting a bug, your
259problem may be already fixed there.
260
261In fact, of course, I wrote this documentation after figured out how to do this
262setup, so maybe I left out some steps. If you needed 'any' additional tricks,
263then it would be nice to include them here.
264
265== Known bugs
266
267- None at this time.
268
269== Screenshots
270
271You can reach some screenshots link:shot[here].
272
273== Additional resources
274
275You can reach the Changelog link:Changelog[here], and a gitweb interface
276http://vmiklos.hu/gitweb/?p=bitlbee-skype.git[here].
277
278The Skype API documentation is
279https://developer.skype.com/Docs/ApiDoc[here] if you're interested.
280
281
282== Testimonials
283
284----
28500:56 < scathe> vmiklos: I like your skype plugin :)
286----
287
288----
289It's really working great so far.
290
291Good Job and thank you!
292Sebastian
293----
294
295== Thanks
296
297for the following people:
298
299* Wilmer van der Gaast, for answering questions about the BitlBee plugin interface
300
301* Arkadiusz Wahlig, author of skype4py, for making suggestions to skyped
302
303* Gabor Adam Toth (tg), for noticing extra code is needed to handle multiline
304  messages
305
306* Cristobal Palmer (tarheelcoxn), for helping to testing the plugin in a
307  timezone different to mine
308
309* people on `#bitlbee` for feedback
310
311Back to my link:/projects[projects page].
312
313// vim: ft=asciidoc
Note: See TracBrowser for help on using the repository browser.