bkFace  -  Face plugin for Becky!
version 1.0.0 [BETA3] [14-Aug-2005]

Copyright  2005 by Code-Breaker Software
http://www.code-breaker.com
Send comments to cbrown@code-breaker.com


/////////////////////////////////////////////////////////////////////////////
/// Description

bkFace is a plugin that will allow you to view a 'face' header in emails that
contain such data. bkFace is similar to the bkxface plugin, but the face 
specification is completely different from the x-face spec so they are not 
compatible, and you will not be able to view x-face headers with bkface (and
vica versa). The face specification is superior to x-face, because it allows
color bit-depths greater than 1 (black and white). 

The face header specification is rather simple. It is a base-64 encoded png
image, of size 48x48. While simple, there are some important limitations to 
the properties of the image. When creating your face image, the finished png
must not be more than 725 bytes in size. 


/////////////////////////////////////////////////////////////////////////////
/// Package

The original download location of this file is here:

http://www.code-breaker.com/down/bkFace.zip

bkFace.zip contains:
 bkFace.dll 
 faceview.exe
 bkFace.txt (the file your reading)


/////////////////////////////////////////////////////////////////////////////
/// Installation

1. Close Becky! 
2. Copy the 3 files contained in the zip to your Becky! plugins folder
   (default is: c:\Becky!\PlugIns\). 
3. Restart Becky!
4. When you click on an email that contains a face header, the image will
   be displayed. 


/////////////////////////////////////////////////////////////////////////////
/// Liability Disclaimer

Your not allowed to sue me! Called it!


/////////////////////////////////////////////////////////////////////////////
///Credits

-bkFace is just an interface to the excellent faceview.exe app, which does all 
 of the heavy lifting. faceview.exe was written by Maik Prinz. 
 http://www.2prinz.de/dialog/face.htm


/////////////////////////////////////////////////////////////////////////////
/// Useful Info / Known Bugs / Limitations

-When a face image is being displayed, you can drag it around the screen to
 where you want it. The location is saved, and the next face image will show
 up in the same place. 

-faceview.exe creates an 'ini' file in Becky's plugins folder called 
 'faceview.ini'. 3 settings are saved: X and Y window coordinates, and 
 'CutTime', which is the number of seconds to display a face image. You can 
 change these settings if you like. Set CutTime to 0 and the face viewer window 
 will not close by itself. 

-To close the face viewer window manually, right-click on it. 

-The best way to get your png image down to 725 bytes is to decrease the 
 number of colors. 8 will usually get you pretty close. 

-Once you have created your png image, and ensured that it is less than 725 
 bytes, you need to encode it to base64. To do this, you can use Maik's 
 pngtoface.exe:
 http://www.2prinz.de/dialog/face.htm

 What I did instead was just to attach the image to a message in Becky, save 
 the message to drafts, then view source. The block of characters in the 
 attachment is your face data. 

-OK. Now you have your encoded face data. To attach it to a message (or 
 template), in the compose window click the headers button. In the 'Header' 
 field, type 'Face'. In the 'Data' field, paste in the base64 data. Remember, 
 no line breaks. 
 
-For more information on the face header specification, go here:
 http://quimby.gnus.org/circus/face/
 
-There are certain instances in which the face viewer window should be closed, 
 but it stays open (eg., when you switch to another application). There isn't 
 much that can be done about that. Sorry.


/////////////////////////////////////////////////////////////////////////////
/// Change Log
  + = Added feature
  * = Improved/changed feature
  - = Bug fixed

1.0 [BETA3] [14-Aug-2004] 
+ The face viewer window now closes on the following events: 
    : when you select a message that does not contain a face header
    : when you select a new folder
    : when you open the compose window
    : when you close Becky

1.0 [BETA2] [14-Aug-2004] 
* Internal release only. Rewritten in c++ (originally in Delphi)
* Plugin wasn't working for some people. I THINK this should be fixed now

1.0 [BETA1] [13-Aug-2004] 
First public release
--
