source: skype/README @ e5c0175

Last change on this file since e5c0175 was e5c0175, checked in by VMiklos <vmiklos@…>, at 2007-09-04T18:48:47Z

mention the tested skype version

  • Property mode set to 100644
File size: 4.9 KB
Line 
1= Skype plugin for BitlBee
2Miklos Vajna <vmiklos@frugalware.org>
3
4== Status
5
6One day I browsed the BitlBee bugtracker and found
7http://bugs.bitlbee.org/bitlbee/ticket/82[this] ticket. Then after a while I
8returned and saw that it was still open. So I wrote it. Not a big deal, I wrote
9it in two days or so (and not because I'm a genius or anything ;-) ). I think
10it's pretty stable, but it needs wider testing. Also see the 'Known bugs'
11section, I really hope those random hangups will be fixed soon by Skype.
12
13Oh, before I forget. I'm not a wizard, the Skype API documentation is
14https://developer.skype.com/Docs/ApiDoc[here] if you're interested.
15
16== How to set it up
17
18Before you start. The setup is the following: BitlBee can't connect directly to
19Skype servers (the company's ones). It needs a running Skype client to do so.
20In fact BitlBee will connect to `skyped` (a tcp server, provided in this
21package) and `skyped` will connecto to your Skype client.
22
23NOTE: The order is important. First you have to start Skype. Then `skyped` can
24connect to it, finally BitlBee can connect to `skyped`. (In fact `skyped`
25automatically reconnect if you restart Skype.)
26
27- If you happen to be a happy Frugalware user, you can install the `bitlbee`
28  and `bitlbee-skype` packages from
29  http://ftp.frugalware.org/pub/other/people/vmiklos/bmf/[my repo].
30
31- You need the BitlBee bzr branch:
32
33----
34bzr branch http://code.bitlbee.org/bitlbee/
35----
36
37NOTE: You no longer need additional patches, as of revision 245.
38
39- Now compile and install it:
40
41----
42./configure
43make
44make install install-dev
45----
46
47- Get the plugin code:
48
49----
50git clone http://ftp.frugalware.org/pub/other/people/vmiklos/bitlbee-skype/.git
51----
52
53(Or you can use the tarballs below, see the Changelog about what
54features/bugfixes will you miss in this case).
55
56- Compile and install it:
57
58----
59make prepare
60./configure
61make
62make install
63----
64
65- Install http://skype4py.sourceforge.net/[Skype4Py].
66
67(You may remember that previous versions of `skyped` did not require this
68package. This because it now uses the X11 interface of Skype (because the
69previously used DBus interface had
70http://forum.skype.com/index.php?s=&showtopic=94545&view=findpost&p=431710[known
71problems]), but I wanted to prevent a large code duplication from that project.
72In addition it then no longer requires the `dbus-python` package, just
73`pygobject`.)
74
75- Install Skype 1.4.0.99. 1.4.0.74 did *not* work for me.
76
77- Start Skype and `skyped` (the tcp server):
78
79----
80skype
81skyped
82----
83
84NOTE: It's important to start skyped on the same machine and using the same
85user as you run Skype as it uses the session DBus for communication!
86
87- Start your IRC client, connect to BitlBee and add your account:
88
89----
90account add skype <user> <pass>
91account set 0/server localhost
92----
93
94IMPORTANT: <user> should be your skype account name. This way you won't see
95yourself joining to `&bitlbee`.
96
97NOTE: the <pass> option is not used currently.
98
99== Setting up Skype in a VNC server (optional)
100
101Optionally, if you want to run Skype on a server, you might want to setup up
102a VNC server as well. I used `tightvnc` but probably other VNC servers will
103work, too.
104
105First run
106
107----
108vncpasswd ~/.vnc/passwd
109----
110
111and create a password. You will need it at least once.
112
113Now create `~/.vnc/xstartup` with the following contents:
114
115----
116#!/bin/sh
117
118/usr/bin/sleep 1
119/usr/bin/skype &
120/usr/bin/sleep 5
121/usr/sbin/skyped
122----
123
124Adjust the permissions:
125
126----
127chmod +x ~/.vnc/xstartup
128----
129
130Then start the server:
131
132----
133vncserver
134----
135
136Then connect to it, and set up Skype (username, password, enable autologin, and
137allow the `SkypeApiPythonShell` client when Skype asks about it).
138
139== What works
140
141- Download nicks and away statuses from Skype
142
143- Noticing joins / parts while we're connected
144
145- Sending messages
146
147- Receiving messages
148
149- Receiving away status changes
150
151- `skyped` (the tcp daemon that is a gateway between Skype and tcp)
152
153- Error handling when `skyped` is not running and when it exits
154
155- Marking received messages as seen so that Skype won't say there are unread messages
156
157- Adding / removing contacts
158
159- Set away state when you do a `/away`.
160
161- When you `account off`, Skype will set status to `Offline`
162
163- When you `account on`, Skype will set status to `Online`
164
165- Detect when somebody wants to add you and ask for confirmation
166
167== What needs to be done (aka. TODO)
168
169- Group chat support. Sadly I'm not too motivated to implement this at the
170  moment.
171
172- Add a question callback for calls.
173
174== I would like to have support for ...
175
176If something does not work and it's not in the TODO section, then please
177contact me!
178
179In fact, of course, I wrote this documentation after figured out how to do this
180setup, so maybe I left out some steps. If you needed 'any' additional tricks,
181then it would be nice to include them here.
182
183== Known bugs
184
185- None at this time.
186
187== Screenshots
188
189You can reach some screenshots http://frugalware.org/~vmiklos/pics/shots/bitlbee-skype/[here].
190
191== Changelog
192
193You can reach the Changelog link:Changelog[here].
194
195// vim: ft=asciidoc
Note: See TracBrowser for help on using the repository browser.