source: skype/README @ 9c90281

Last change on this file since 9c90281 was 9c90281, checked in by VMiklos <vmiklos@…>, at 2007-08-30T22:48:33Z

README: no more patches are required, wilmer merged them :)

  • Property mode set to 100644
File size: 4.7 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- Start Skype and `skyped` (the tcp server):
66
67----
68skype
69skyped
70----
71
72NOTE: It's important to start skyped on the same machine and using the same
73user as you run Skype as it uses the session DBus for communication!
74
75- Start your IRC client, connect to BitlBee and add your account:
76
77----
78account add skype <user> <pass>
79account set 0/server localhost
80----
81
82IMPORTANT: <user> should be your skype account name. This way you won't see
83yourself joining to `&bitlbee`.
84
85NOTE: the <pass> option is not used currently.
86
87== Setting up Skype in a VNC server (optional)
88
89Optionally, if you want to run Skype on a server, you might want to setup up
90a VNC server as well. I used `tightvnc` but probably other VNC servers will
91work, too.
92
93First run
94
95----
96vncpasswd ~/.vnc/passwd
97----
98
99and create a password. You will need it at least once.
100
101Now create `~/.vnc/xstartup` with the following contents:
102
103----
104#!/bin/sh
105
106/usr/bin/sleep 1
107/usr/bin/skype &
108/usr/bin/sleep 5
109/usr/sbin/skyped
110----
111
112Adjust the permissions:
113
114----
115chmod +x ~/.vnc/xstartup
116----
117
118Then start the server:
119
120----
121vncserver
122----
123
124Then connect to it, and set up Skype (username, password, enable autologin, and
125allow the `SkypeApiPythonShell` client when Skype asks about it).
126
127== What works
128
129- Download nicks and away statuses from Skype
130
131- Noticing joins / parts while we're connected
132
133- Sending messages
134
135- Receiving messages
136
137- Receiving away status changes
138
139- `skyped` (the tcp daemon that is a gateway between Skype and tcp)
140
141- Error handling when `skyped` is not running and when it exits
142
143- Marking received messages as seen so that Skype won't say there are unread messages
144
145- Adding / removing contacts
146
147- Set away state when you do a `/away`.
148
149- When you `account off`, Skype will set status to `Offline`
150
151- When you `account on`, Skype will set status to `Online`
152
153- Detect when somebody wants to add you and ask for confirmation
154
155== What needs to be done (aka. TODO)
156
157- Group chat support. Sadly I'm not too motivated to implement this at the
158  moment.
159
160- Support for receiving messages which consists of multiple lines.
161
162- Support for receiving edited messages.
163
164- Add a question callback for calls.
165
166== I would like to have support for ...
167
168If something does not work and it's not in the TODO section, then please
169contact me!
170
171In fact, of course, I wrote this documentation after figured out how to do this
172setup, so maybe I left out some steps. If you needed 'any' additional tricks,
173then it would be nice to include them here.
174
175== Known bugs
176
177- Sometimes when you get a lot of messages in a short time, some of the
178  messages are dropped. This is a known bug in Skype itself as of version
179  1.4.0.99
180  (http://forum.skype.com/index.php?s=&showtopic=94545&view=findpost&p=431710[link]).
181
182== Screenshots
183
184You can reach some screenshots http://frugalware.org/~vmiklos/pics/shots/bitlbee-skype/[here].
185
186== Changelog
187
188You can reach the Changelog link:Changelog[here].
189
190// vim: ft=asciidoc
Note: See TracBrowser for help on using the repository browser.