1 

     2 # Personal Eventing Protocol modules

     3 

     4 This is a set of modules, that provide notfication about other's events

     5 and allow you to publish yours.

     6 

     7 'Pep' module provides common listener for incoming PEP events.

     8 

     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]]

    19 

    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.

    24 

    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 

    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.

    33 

    34 Note: In order for you to actually publish something, your server must

    35 support PEP, and that is still not that widely available. Still, even

    36 if your server does not, you can load modules to be notified about your

    37 buddies events.

    38 

    39 All of the modules also provide C headers for other C modules to use

    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.

    43 

    44 # Installation

    45 

    46 To install it, you need:

    47 

    48  * mcabber headers

    49  * glib

    50  * loudmouth

    51  * cmake

    52  * make

    53  * c compiler (gcc)

    54  * linker (binutils)

    55 

    56 Then do:

    57 

    58     $ mkdir build

    59     $ cd build

    60     $ cmake ..

    61     $ make edit_cache

    62     $ make

    63     # make install

    64 

    65 Debian users can instead of make install do:

    66 

    67     $ make package

    68     # dpkg -i libmcabber-pep_*.deb

    69 

    70 Users of other distributions can select appropriate package generator,

    71 using cache editor.

    72 

    73 # License

    74 

    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/>.

    78 

    79 # Contact

    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