annotate libpurple/protocols/null/README @ 32533:e091c8ea292e

Pluck all MSNP18 changes. This is pretty much to fix sending OIMs. *** Plucked rev b8b574c4d6f6c05105b372191ca5259b4ae0ad41 ([e-mail]): Add a function for parsing a network:username for MSNP18. *** Plucked rev 86bb401efa33f02ca5d28fea216a39a3cf29b5b4 ([e-mail]): Fix UBX on MSNP18. *** Plucked rev ba2513694e6abcbdfddc66820f1df20540a36847 ([e-mail]): Fix NLN on MSNP18. *** Plucked rev 83a617670da618f4dbdeeebbdb5e2813a4ad2c0c ([e-mail]): Switch to ABFindContactsPaged instead of ABFindAll. *** Plucked rev b6bd214d29db885c6d28628c163fa144bdf4a76d ([e-mail]): Send circle authentication on the notification server on MSNP18. *** Plucked rev 2ca50146aa67469313579cea414e4a2b660939aa ([e-mail]): Make a small name change. *** Plucked rev 2c13bf358104060d6713317e18e03b434862cb38 ([e-mail]): Add a missing function. *** Plucked rev a8deb3f73726f4148e8f36f317a88fedcb051c34 ([e-mail]): Update UUM to allow sending to users on any network. *** Plucked rev dddff988e830a7a2fa0e40aad200f0e908b9231e ([e-mail]): Switch to MSNP18. *** Plucked rev 9fe45819000c530c509c07b7feb29ce9d4ea13b0 ([e-mail]): Send offline messages using UUM. *** Plucked rev c1584182b85f99fa3507ea3f76b07865ee7e43f7 ([e-mail]): Drop support for protocols below 18. *** Plucked rev f0388e54998489dbe4b6133796f77459f20fe884 ([e-mail]): Fix indices for client capabilities and display pics.

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.