1 |
1 docs/readme.mdwn |
2 This is a module, implementing avatar publishing/retrieving via pep/pubsub. |
|
3 This module informs you, when your buddies publish their avatars via pep |
|
4 and provides command '/avatar' to publish your own. But this is not all. |
|
5 It also will show you buddy's avatar! Yes, it is aalib :) |
|
6 |
|
7 This module depends on module 'pep'. |
|
8 |
|
9 For this module to actually do something you should set option |
|
10 avatars_directory - a place, where your buddy's avatars will be saved. |
|
11 |
|
12 Note, that currently only pubsub-publishing of avatars is supported |
|
13 (retrieving too works only for pubsub, but there you will be at least |
|
14 informed of url, that you can use to view avatar manually). Thus, as |
|
15 standard states, that pubsub-published data must be image/png, your |
|
16 avatar should be in png format. |
|
17 |
|
18 To receive notifications you need only to load it (better at startup, as |
|
19 I had some problems otherwise due to server's caching features). Then when |
|
20 your buddy will change avatar, you will receive notification and new |
|
21 avatar will be downloaded, saved and printed to buddy's window. To publish |
|
22 avatar you need your server to support both pep and pubsub (many public |
|
23 jabber servers offer only pubsub or neither, while for example prosody in |
|
24 default debian's complectation supports only pep). |
|
25 |
|
26 You can use AAOPTS environment variable to set aalib operation options, like |
|
27 contrast, brightness, etc (you can change mcabber environment at run-time |
|
28 with env module). For a list of options see aalib documentation: |
|
29 http://aa-project.sourceforge.net/aalib/aalib_9.html |
|
30 |
|
31 INSTALLATION |
|
32 |
|
33 To install it, you need: |
|
34 loudmouth |
|
35 glib |
|
36 aalib |
|
37 libpng |
|
38 mcabber's headers |
|
39 pep module's headers |
|
40 cmake |
|
41 make |
|
42 gcc |
|
43 |
|
44 Then do |
|
45 $ mkdir build |
|
46 $ cd build |
|
47 $ cmake .. |
|
48 $ make edit_cache |
|
49 $ make |
|
50 # make install |
|
51 |
|
52 Debian users can instead of make install do |
|
53 $ fakeroot make package |
|
54 # dpkg -i libmcabber-avatar*.deb |
|
55 |
|
56 Users of other distributions can select appropriate package |
|
57 generator, using cache editor. |
|
58 |
|
59 LICENSE |
|
60 |
|
61 This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING |
|
62 from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>. |
|
63 |
|
64 CONTACTS |
|
65 |
|
66 I will be happy to get feedback, patches, suggestions, etc. |
|
67 You can send me email or contact via jabber <isbear@unixzone.org.ua>. |
|
68 |
|
69 -- Myhailo Danylenko <isbear@ukrpost.net> |
|
70 |
|
71 |
|