==Badwords add-on for miniBB==

Release date: February 14, 2022.
Latest update: January 31, 2022.
Author: Paul Puzyrev (minibb.com)

The Badwords add-on will try to mask any 's-word', coming from a pre-specified list, posted in the forum, also forbid usernames on Sign up, which contain such a word or fragment. 


==INSTALLATION==

- Upload `addon_badwords.php` to your forums root folder.

- Upload `addon_badwords_list.php` to your forums root folder - if necessary, edit it and add new words, or remove some from this list. It's possible to define the fragments of words, which should be caught exactly as a word, from the beginning of a word, or as any fragment. Default version provides the most commonly used s-words from English and Russian in alphabetical order. The format should correspond to the standard PHP array format. Follow the original file and keep this syntax - each fragment enclosed in apostrophes, and followed by comma. Note: preferrably do not put the comma after the last word.

- Edit your forums language pack (`lang/eng.php` or whatever), and at the end of it before the closing ?> paste the wording from the language snippet located in the /lang/ folder of this add-on - choose the proper prefix for your pack.

- Edit `bb_plugins_user.php` located in your forums folder, and before the closing ?> paste the code found in `bb_plugins_user.code.txt`.

- Edit `bb_plugins.php` located in your forums folder, and at any place not related to the contents of other add-ons, paste the code found in `bb_plugins.code.txt`.


==CONFIGURATION==

The replacement method by default reveals the first letter of a 'badword'. This is done for making the text more understood. For masking the 'badword' completely, add this to setup_options.php:

define('BADWORDS_REVEAL', 0);


==NOTES==

Keep in mind that this add-on will supress only pre-specified fragments, which are clean and clear. Technically, it's almost impossible to get all the workarounds and to get this to work well in all cases. For example, someone could post 'f u c k' or 'f--u-c--k' instead of just 'fuck', and this will pass. "People will swear when they want to, this wont stop them at all." (c)

Note that Admin and Moderators are excluded from s-words checks, they could post everything.


==FINALLY==

Enjoy using miniBB!
Our forums will help you on any question you may have regarding this add-on:
http://www.minibb.com/forums/11_4221_0.html
