source: skype/README @ 8e3058b

Last change on this file since 8e3058b was 8e3058b, checked in by VMiklos <vmiklos@…>, at 2007-08-21T18:51:55Z

update documentation for buildsystem changes

  • Property mode set to 100644
File size: 3.6 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
24connect to it, finally BitlBee can connect to `skyped`.
25
[afe221f]26- You need the BitlBee bzr branch:
27
[0c60f96]28----
[afe221f]29bzr branch http://code.bitlbee.org/bitlbee/
[0c60f96]30----
[afe221f]31
[b8b0bfd]32- You need some additional patches:
[afe221f]33
[0c60f96]34----
[afe221f]35http://frugalware.org/~vmiklos/patches/bitlbee-configure-plugins.patch
[b8b0bfd]36http://frugalware.org/~vmiklos/patches/bitlbee-global-conf-may-be-null.patch
[afe221f]37http://frugalware.org/~vmiklos/patches/bitlbee-makefile-headers.patch
[b8b0bfd]38http://frugalware.org/~vmiklos/patches/bitlbee-more-verbose-on-plugin-errors.patch
[0c60f96]39----
[afe221f]40
[b8b0bfd]41(Yes, I submitted all of them to the
42http://bugs.bitlbee.org/bitlbee/[bugtracker] already.)
43
[afe221f]44- Now compile and install it:
45
[0c60f96]46----
[8e3058b]47./configure
[afe221f]48make
49make install install-dev
[0c60f96]50----
[afe221f]51
52- Get the plugin code:
53
[0c60f96]54----
[afe221f]55git clone http://ftp.frugalware.org/pub/other/people/vmiklos/bitlbee-skype
[0c60f96]56----
[afe221f]57
58- Compile and install it:
59
[0c60f96]60----
[8e3058b]61make prepare
62./configure
[afe221f]63make
[8e3058b]64make install
[0c60f96]65----
[afe221f]66
[ed2e37f]67- Start skyped (the tcp server):
[afe221f]68
[0c60f96]69----
[ba20c39]70python skyped.py
[0c60f96]71----
[ba20c39]72
73NOTE: It's important to start skyped on the same machine and using the same
74user as you run Skype as it uses the session DBus for communication!
[afe221f]75
[7338d59]76- Start your IRC client, connect to BitlBee and add your account:
77
78----
79account add skype <user> <pass>
80account set 0/server localhost
81----
82
83IMPORTANT: <user> should be your skype account name. This way you won't see
84yourself joining to `&bitlbee`.
85
86NOTE: the <pass> option is not used currently.
87
[9e03e55]88== What works
[b6d26ac]89
[adce2de]90- Download nicks and away statuses from Skype
[b6d26ac]91
[39a0d64]92- Noticing joins / parts while we're connected
93
[93ece66]94- Sending messages
95
[8dd21bb]96- Receiving messages
97
[72f697b]98- Receiving away status changes
99
[62bb4e4]100- `skyped` (the tcp daemon that is a gateway between Skype and tcp)
[ed2e37f]101
[62bb4e4]102- Error handling when `skyped` is not running and when it exits
[afe221f]103
[62bb4e4]104- Marking received messages as seen so that Skype won't say there are unread messages
[440665b]105
[6627d92]106- Adding / removing contacts
107
[23411c6]108- Set away state when you do a `/away`.
109
[d3cbd17]110- When you `account off`, Skype will set status to `Offline`
[348a3a2]111
[d3cbd17]112- When you `account on`, Skype will set status to `Online`
[348a3a2]113
[d3cbd17]114- Detect when somebody wants to add you and ask for confirmation
[8dd21bb]115
[d3cbd17]116== What needs to be done (aka. TODO)
[93ece66]117
[0c60f96]118== I would like to have support for ...
119
[afe221f]120If something does not work and it's not in the TODO section, then please contact me!
121
[f78f949]122== Known bugs
123
124- Sometimes when you get a lot of messages in a short time, some of the
125  messages are dropped. This is a known bug in Skype itself as of version
126  1.4.0.99
127  (http://forum.skype.com/index.php?s=&showtopic=94545&view=findpost&p=431710[link]).
128
[0c60f96]129== Screenshots
130
131You can reach some screenshots http://frugalware.org/~vmiklos/pics/shots/bitlbee-skype/[here].
[ddd3502]132
[a60c3c2]133== Changelog
134
135You can reach the Changelog link:Changelog[here].
136
[0c60f96]137// vim: ft=asciidoc
Note: See TracBrowser for help on using the repository browser.