summaryrefslogtreecommitdiff
path: root/README
blob: ca78acc296da3f74217665aa0aa47e248bb7105a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Globster
========


So what's this?

  This is yet another attempt at writing a client for the Direct Connect
  network that tries to fulfil the following goals (in no particular order):

  - Client-server, as in, there's a background daemon that does all the work
    and you can have multiple front-ends (possibly on different machines).

  - Efficient in both CPU and memory usage. Comparable to, but preferably
    better than, ncdc.

  - Extensible and scriptable. The deamon should abstract away all
    protocol-related behaviour and do most of the heavy work, in order to
    facilitate writing bots, scripts and user interfaces for Direct Connect.

  - It should be possible to write scripts and interfaces in any (serious)
    programming language. Currently, this is done by using D-Bus as IPC
    mechanism.

  More information can be found on the homepage:
    http://dev.yorhel.nl/globster



And how do I use it?

  Clone the git repo and get some dependencies:

    git clone git://g.blicky.net/globster.git
    cd globster
    git submodule init
    git submodule update

  To build the 'globster' binary:

    autoreconf -i
    ./configure
    make

  To run it:

    ./globster

  It will then connect to some D-Bus bus, via which you can control the daemon.
  (TODO: Explain how you can start your own bus specifically for globster if
   you don't have or want a session bus)

  You can then use dbus-send from the commandline, d-feet if you want a simple
  GTK interface to experiment with, or the D-Bus bindings for your favourite
  language[1] to interact with the daemon. The D-Bus API is documented in
  doc/api.pod in this repository, and is also available online at
  http://dev.yorhel.nl/globster/api.

  1. http://www.freedesktop.org/wiki/Software/DBusBindings



Who should I blame for this crap?

  projects@yorhel.nl
  adc://dc.blicky.net:2780/