==README for addon_smilies.php==
Release date: November 30, 2004
Latest update: June 11, 2024
miniBB version: 3.3 and up
Author: Paul Puzyrev (minibb.com)

This add-on to miniBB allows visitors use so called "smilies" in their posts. Smilies are graphical interpretations of symbols like ":)", ":(", ":lol:" etc., which are used in many communication softwares around. Script replaces smilies by the pictures. Note than smilies can "distort" your graphical design, also the website's traffic will grow because each smiley's pic loads the full image URL in the HTML source.

==INSTALLATION==

***** Copy addon_smilies.php to your forums folder.

***** Copy templates/addon_smilies_func.html, templates/addon_smilies_img.html to your forums/templates folder.

***** Under [IMG] folder of your forums, create subfolder "smilies". Copy all desired smilies and smdesc.php file there, like it is shown in the package. Take care about the copyright and create your own smilies if you are not satisfied with the attached (read below how to assign them to the program).

***** Modify your language pack(s) (/lang/eng.php or whatever) and paste to the end of file new definitions located under /lang/end.code.txt (or the proper LANG.code.txt if present - translate them if necessary)

***** Edit bb_plugins.php and copy/paste the code provided in bb_plugins.code.txt

***** Edit templates/main_post_form.html and paste:

{$smiliesFuncCode} - at the functional part of the table, where BB-code buttons are located - BUT it should be pasted BELOW the reference which says `<!--/BBJSBUTTONS-->`, i.e. it should not be the part of "BBJSBUTTONS" block;
{$smiliesImgCode} - at the place where smilie images should appear (it should appear below the {$smiliesFuncCode}).


==SETUP==

1) Open addon_smilies.php in some ASCII editor and edit this parameter:
* $dirname = 'smilies'; Determine directory name you have created for smilies.

2) Smilies definitions are kept in smdesc.php file (it should obligately exist in the 'smilies' folder!). If you need to add some new defs, or edit given, modify this file by the same principle as it's shown. Definitions are saved in the PHP associative array format:

$smilies=array(
':-)'=>'grin.gif',
==================etc.etc.etc.==================
':spy:'=>'spy.gif',
':)'=>'grin.gif',
);

It means: 

'SMILEY_DEFINITION'=>'SMILEY_FILENAME',

preferrable no comma should follow after the last element of this array.

You may refer to PHP manual for more information on how to store associative arrays.

NB:

- Always put the ':)' to the end of the $smilies array.
- Do not set the smiliey :/ since it could be concerned as URL fragment (http://)


==NOTES==


* If the smiley is not displayed in your post (or "empty square") is displayed, it means the browser just can't find the image specified. Make sure it is properly uploaded under smilies folder; view full page source for checking the missing URL and apply the corrective updates to you configuration file.



==FINALLY==

Hope, you'll enjoy. Please, post bugs and suggestions on our forums:
http://www.minibb.com/forums/11_4192_0.html
