source: skype/README @ 4eaff41

Last change on this file since 4eaff41 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
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
[2fcad6e]65- Start Skype and `skyped` (the tcp server):
[afe221f]66
[0c60f96]67----
[2fcad6e]68skype
69skyped
[0c60f96]70----
[ba20c39]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!
[afe221f]74
[7338d59]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
[23b84e1]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
[57087df]112Adjust the permissions:
113
114----
115chmod +x ~/.vnc/xstartup
116----
117
[23b84e1]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
[9e03e55]127== What works
[b6d26ac]128
[adce2de]129- Download nicks and away statuses from Skype
[b6d26ac]130
[39a0d64]131- Noticing joins / parts while we're connected
132
[93ece66]133- Sending messages
134
[8dd21bb]135- Receiving messages
136
[72f697b]137- Receiving away status changes
138
[62bb4e4]139- `skyped` (the tcp daemon that is a gateway between Skype and tcp)
[ed2e37f]140
[62bb4e4]141- Error handling when `skyped` is not running and when it exits
[afe221f]142
[62bb4e4]143- Marking received messages as seen so that Skype won't say there are unread messages
[440665b]144
[6627d92]145- Adding / removing contacts
146
[23411c6]147- Set away state when you do a `/away`.
148
[d3cbd17]149- When you `account off`, Skype will set status to `Offline`
[348a3a2]150
[d3cbd17]151- When you `account on`, Skype will set status to `Online`
[348a3a2]152
[d3cbd17]153- Detect when somebody wants to add you and ask for confirmation
[8dd21bb]154
[d3cbd17]155== What needs to be done (aka. TODO)
[93ece66]156
[b7f7100]157- Group chat support. Sadly I'm not too motivated to implement this at the
158  moment.
[0ac1b3e0]159
[292be68]160- Support for receiving messages which consists of multiple lines.
161
162- Support for receiving edited messages.
163
[846ceffb]164- Add a question callback for calls.
165
[0c60f96]166== I would like to have support for ...
167
[23b84e1]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.
[afe221f]174
[f78f949]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
[0c60f96]182== Screenshots
183
184You can reach some screenshots http://frugalware.org/~vmiklos/pics/shots/bitlbee-skype/[here].
[ddd3502]185
[a60c3c2]186== Changelog
187
188You can reach the Changelog link:Changelog[here].
189
[0c60f96]190// vim: ft=asciidoc
Note: See TracBrowser for help on using the repository browser.