source: skype/README @ 40d2dc4

Last change on this file since 40d2dc4 was c15f71a, checked in by VMiklos <vmiklos@…>, at 2007-09-04T16:59:28Z

skyped: use Skype4Py's X11 api
this solves all those weird freezes

  • Property mode set to 100644
File size: 4.9 KB
RevLine 
[0c60f96]1= Skype plugin for BitlBee
2Miklos Vajna <vmiklos@frugalware.org>
[afe221f]3
[56e4ac4]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
[56b56478]8returned and saw that it was still open. So I wrote it. Not a big deal, I wrote
[56e4ac4]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
[75742cc]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
[9e03e55]16== How to set it up
[afe221f]17
[751b149]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
[7e4f0ca1]23NOTE: The order is important. First you have to start Skype. Then `skyped` can
[64f8b8ea]24connect to it, finally BitlBee can connect to `skyped`. (In fact `skyped`
25automatically reconnect if you restart Skype.)
[7e4f0ca1]26
[11eed8f]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
[afe221f]31- You need the BitlBee bzr branch:
32
[0c60f96]33----
[afe221f]34bzr branch http://code.bitlbee.org/bitlbee/
[0c60f96]35----
[afe221f]36
[9c90281]37NOTE: You no longer need additional patches, as of revision 245.
[b8b0bfd]38
[afe221f]39- Now compile and install it:
40
[0c60f96]41----
[8e3058b]42./configure
[afe221f]43make
44make install install-dev
[0c60f96]45----
[afe221f]46
47- Get the plugin code:
48
[0c60f96]49----
[99426f0]50git clone http://ftp.frugalware.org/pub/other/people/vmiklos/bitlbee-skype/.git
[0c60f96]51----
[afe221f]52
[b8351a2]53(Or you can use the tarballs below, see the Changelog about what
54features/bugfixes will you miss in this case).
55
[afe221f]56- Compile and install it:
57
[0c60f96]58----
[8e3058b]59make prepare
60./configure
[afe221f]61make
[8e3058b]62make install
[0c60f96]63----
[afe221f]64
[c15f71a]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
[2fcad6e]75- Start Skype and `skyped` (the tcp server):
[afe221f]76
[0c60f96]77----
[2fcad6e]78skype
79skyped
[0c60f96]80----
[ba20c39]81
82NOTE: It's important to start skyped on the same machine and using the same
83user as you run Skype as it uses the session DBus for communication!
[afe221f]84
[7338d59]85- Start your IRC client, connect to BitlBee and add your account:
86
87----
88account add skype <user> <pass>
89account set 0/server localhost
90----
91
92IMPORTANT: <user> should be your skype account name. This way you won't see
93yourself joining to `&bitlbee`.
94
95NOTE: the <pass> option is not used currently.
96
[23b84e1]97== Setting up Skype in a VNC server (optional)
98
99Optionally, if you want to run Skype on a server, you might want to setup up
100a VNC server as well. I used `tightvnc` but probably other VNC servers will
101work, too.
102
103First run
104
105----
106vncpasswd ~/.vnc/passwd
107----
108
109and create a password. You will need it at least once.
110
111Now create `~/.vnc/xstartup` with the following contents:
112
113----
114#!/bin/sh
115
116/usr/bin/sleep 1
117/usr/bin/skype &
118/usr/bin/sleep 5
119/usr/sbin/skyped
120----
121
[57087df]122Adjust the permissions:
123
124----
125chmod +x ~/.vnc/xstartup
126----
127
[23b84e1]128Then start the server:
129
130----
131vncserver
132----
133
134Then connect to it, and set up Skype (username, password, enable autologin, and
135allow the `SkypeApiPythonShell` client when Skype asks about it).
136
[9e03e55]137== What works
[b6d26ac]138
[adce2de]139- Download nicks and away statuses from Skype
[b6d26ac]140
[39a0d64]141- Noticing joins / parts while we're connected
142
[93ece66]143- Sending messages
144
[8dd21bb]145- Receiving messages
146
[72f697b]147- Receiving away status changes
148
[62bb4e4]149- `skyped` (the tcp daemon that is a gateway between Skype and tcp)
[ed2e37f]150
[62bb4e4]151- Error handling when `skyped` is not running and when it exits
[afe221f]152
[62bb4e4]153- Marking received messages as seen so that Skype won't say there are unread messages
[440665b]154
[6627d92]155- Adding / removing contacts
156
[23411c6]157- Set away state when you do a `/away`.
158
[d3cbd17]159- When you `account off`, Skype will set status to `Offline`
[348a3a2]160
[d3cbd17]161- When you `account on`, Skype will set status to `Online`
[348a3a2]162
[d3cbd17]163- Detect when somebody wants to add you and ask for confirmation
[8dd21bb]164
[d3cbd17]165== What needs to be done (aka. TODO)
[93ece66]166
[b7f7100]167- Group chat support. Sadly I'm not too motivated to implement this at the
168  moment.
[0ac1b3e0]169
[846ceffb]170- Add a question callback for calls.
171
[0c60f96]172== I would like to have support for ...
173
[23b84e1]174If something does not work and it's not in the TODO section, then please
175contact me!
176
177In fact, of course, I wrote this documentation after figured out how to do this
178setup, so maybe I left out some steps. If you needed 'any' additional tricks,
179then it would be nice to include them here.
[afe221f]180
[f78f949]181== Known bugs
182
[c15f71a]183- None at this time.
[f78f949]184
[0c60f96]185== Screenshots
186
187You can reach some screenshots http://frugalware.org/~vmiklos/pics/shots/bitlbee-skype/[here].
[ddd3502]188
[a60c3c2]189== Changelog
190
191You can reach the Changelog link:Changelog[here].
192
[0c60f96]193// vim: ft=asciidoc
Note: See TracBrowser for help on using the repository browser.