author | Myhailo Danylenko <isbear@ukrpost.net> |
Mon, 20 Aug 2012 18:53:05 +0300 | |
changeset 37 | 0477d4800fbd |
parent 29 | README@23fa36d480fb |
permissions | -rw-r--r-- |
5 | 1 |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
2 |
# Personal Eventing Protocol modules |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
3 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
4 |
This is a set of modules, that provide notfication about other's events |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
5 |
and allow you to publish yours. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
6 |
|
37 | 7 |
'Pep' module provides common listener for incoming PEP events. |
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
8 |
|
37 | 9 |
'Tune' module provides '/tune' command to publish music, you are |
10 |
listening to at the moment. However, it does not by itself does that. |
|
11 |
You'll need some other module, that will provide music information, |
|
12 |
like 'mpd' one. Alternatively, you can set up some scripts to publish |
|
13 |
information with '/tune' command via fifo. |
|
14 |
||
15 |
'Mood' module provides '/mood' command to publish your current mood. |
|
16 |
Currently it does not check for validity of its input, so, it's |
|
17 |
strongly suggested to use provided completion for first argument. |
|
18 |
[[List of valid moods|moods]] |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
19 |
|
37 | 20 |
'Geoloc' module provides '/geoloc' command to publish your current |
21 |
location. Currently, there are no known use cases of this module, but I |
|
22 |
hope, that someday there will be a module, that will retrieve |
|
23 |
geolocation information from devices and use this module to publish it. |
|
5 | 24 |
|
37 | 25 |
'Activity' module provides '/activity' command to publish your current |
26 |
activity. Currently it does not check for validity of its input either, |
|
27 |
so, please use completion for first two arguments. |
|
28 |
[[List of valid activities|activities]] |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
29 |
|
37 | 30 |
Modules recognize options 'tune_interval' and 'geoloc_interval' to |
31 |
limit publication rate and option 'tune_pause_is_stop', that controls |
|
32 |
whether tune should publish empty information for paused state. |
|
5 | 33 |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
34 |
Note: In order for you to actually publish something, your server must |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
35 |
support PEP, and that is still not that widely available. Still, even |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
36 |
if your server does not, you can load modules to be notified about your |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
37 |
buddies events. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
38 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
39 |
All of the modules also provide C headers for other C modules to use |
37 | 40 |
to publish data. Note, however, that I plan to switch to events |
41 |
interface for that - it provides multiplexing ability, and in general |
|
42 |
is more flexible. |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
43 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
44 |
# Installation |
5 | 45 |
|
46 |
To install it, you need: |
|
37 | 47 |
|
48 |
* mcabber headers |
|
49 |
* glib |
|
50 |
* loudmouth |
|
51 |
* cmake |
|
52 |
* make |
|
53 |
* c compiler (gcc) |
|
54 |
* linker (binutils) |
|
55 |
||
56 |
Then do: |
|
5 | 57 |
|
37 | 58 |
$ mkdir build |
59 |
$ cd build |
|
60 |
$ cmake .. |
|
61 |
$ make edit_cache |
|
62 |
$ make |
|
63 |
# make install |
|
5 | 64 |
|
37 | 65 |
Debian users can instead of make install do: |
5 | 66 |
|
37 | 67 |
$ make package |
68 |
# dpkg -i libmcabber-pep_*.deb |
|
69 |
||
70 |
Users of other distributions can select appropriate package generator, |
|
71 |
using cache editor. |
|
5 | 72 |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
73 |
# License |
5 | 74 |
|
37 | 75 |
This code underlies terms of GNU GPL v2 or later. You can find it in |
76 |
file COPYING from this distribution or on a GNU web-site |
|
77 |
<http://www.gnu.org/licenses/>. |
|
5 | 78 |
|
37 | 79 |
# Contact |
5 | 80 |
|
81 |
I will be happy to get feedback, patches, suggestions, etc. |
|
82 |
You can send me email or contact via jabber <isbear@unixzone.org.ua>. |
|
83 |
||
84 |
-- Myhailo Danylenko <isbear@ukrpost.net> |
|
85 |