view libpurple/protocols/null/README @ 29105:94f85ba7e5a9

This effectively moves Etan's API addition off im.pidgin.pidgin and onto im.pidgin.pidgin.next.minor so we don't force a 2.7.0 too soon. *** Plucked rev f7d26d95395d5013710b12cfdfcf131aa1033e0c (deryni@pidgin.im): Add a purple_account_get_name_for_display function (I'm not a huge fan of that name but didn't want to use get_display_name as that means something else for connections). This wants to be used in places where we need to display an identifier for the account to the user and honor the appropriate aliases/etc. Refs #8391
author John Bailey <rekkanoryo@rekkanoryo.org>
date Wed, 16 Sep 2009 15:44:26 +0000
parents 0edd1e140b6e
children
line wrap: on
line source

nullprpl

--------
OVERVIEW
--------
Nullprpl is a mock protocol plugin for Pidgin and libpurple. You can create
accounts with it, sign on and off, add buddies, and send and receive IMs, all
without connecting to a server!

Beyond that basic functionality, nullprpl supports presence and away/available
messages, offline messages, user info, typing notification, privacy
allow/block lists, chat rooms, whispering, room lists, and protocol icons and
emblems. Notable missing features are file transfer and account registration
and authentication.

Nullprpl is intended as an example of how to write a libpurple protocol
plugin. It doesn't contain networking code or an event loop, but it does
demonstrate how to use the libpurple API to do pretty much everything a prpl
might need to do.

Nullprpl is also a useful tool for hacking on Pidgin, Finch, and other
libpurple clients. It's a full-featured protocol plugin, but doesn't depend on
an external server, so it's a quick and easy way to exercise test new code. It
also allows you to work while you're disconnected.

-----------------------
BUILDING AND INSTALLING
-----------------------

To build, just run ./configure as usual in the root directory of the pidgin
source distribution. Then cd libpurple/protocols/null and then make.  To
install, run make install.  Then run Pidgin.

To build nullprpl on Windows (with Cygwin/MinGW), use: make -f Makefile.mingw

-----
USAGE
-----
To add a nullprpl account, go to the account editor window and click Add.
Select Nullprpl from the protocol drop-down list, and enter any username you
want.

Now, use Pidgin like normal. You can add buddies, send IMs, set away messages,
etc. If you send IMs to your own username, they will be echoed back to you.