============================================================
INFORMATION
============================================================
This is a collection of patches that add Auto-Squelching
functionality to the source code of:
AngbandTk  2.9.0r2
OmnibandTk 1.4
ZangbandTk 2.4.0r5

-------------------
This patch is based upon patches that David Blackston created
originally for Zangband 2.2.8 and Angband 2.9.0.
I have modified some of his original code by removing
unneeded code, adapting some code, and adding new code to it.
I'd like to thank David for the work he put into his
original patch, without it, I probably wouldn't have even
started this project.

-------------------
Feel free to contact me if you have questions comments or
especially, a bug report.
Brian Magnusen
bmagnusen@yahoo.com


============================================================
DESCRIPTION OF FUNCTIONALITY
============================================================
The Auto-Squelching provided by this patch, can squelch
(delete automatically) items by quality or by type.

==================
Squelch by Quality
==================
This squelches items based on their quality value and is
invoked upon Pseudo-identification, Identification,
*Identification*, or the Mindcrafter class's
Psychometry power.
The various categories of items susceptible to this have
individual squelch level settings so you can squelch for
example all helmets that are not artifacts but not squelch
any dragon scale mail unless it's cursed.
The settings can be from 0 to 4:
0 - Squelch none.
1 - Squelch cursed.
2 - Squelch average and below.
3 - Squelch good and below.
4 - Squelch all but artifacts.

==================
Squelch by Type
==================
This squelches items based on their type and is invoked
upon walking over the item.  This overrides the squelch by
quality; for example if you have your squelch by quality
setting for helmets set to 1 (cursed only), and your
squelch by type setting for Iron Helms turned on,
if you walk over an excellent Iron Helm, it will still be
squelched.  This type of squelching is very good for items
that one doesn't need later on in the game like torches
(after you have an artifact light source) and food items
(after you have satisfy hunger magic or use satisfy hunger
scrolls instead).

=========================
Changing Squelch Settings
=========================
There are two menus for squelching.
Quality Squelching: Other->Preferences->Options->Squelch_Quality
Type Squelching: Other->Preferences->Squelch


============================================================
INSTRUCTIONS for applying the patches
============================================================

COPYING PATCHES OVER:
-------------------------
1. Place the patch file (squelch_angbandtk-2_9_2r2-1_0.pat)
   into your "AngbandTk\src" directory.

2. Place the patch file (squelch_commontk-1_4-1_0.pat)
   into your "OmnibandTk\src\common" directory.

3. Place the patch file (squelch_zangbandtk-2_4_0r5-1_0.pat)
   into your "ZangbandTk\src" directory.

APPLYING PATCHES:
-------------------------
1. Execute "patch -p1 <squelch_angbandtk-2_9_2r2-1_0.pat"
   while in your "AngbandTk\src" directory.

2. Execute "patch -p1 <squelch_commontk-1_4-1_0.pat"
   while in your "OmnibandTk\src\common" directory.

3. Execute "patch -p1 <squelch_zangbandtk-2_4_0r5-1_0.pat"
   while in your "ZangbandTk\src" directory.

COPYING OTHER FILES OVER:
-------------------------
1. Overwrite the file "OmnibandTk-1.4\tk\msgs\option\en.msg"
   with file "en.msg" located in the "Files" directory.

2. Overwrite the files:
   "OmnibandTk-1.4\tk\main-window.tcl"
   "OmnibandTk-1.4\tk\moduleIndex.tcl"
   "OmnibandTk-1.4\tk\options.tcl"
   "OmnibandTk-1.4\tk\squelch.tcl"
   with the updated files located in the "Files" directory.

3. Overwrite the file
   "OmnibandTk-1.4\variant\AngbandTk-292r2\tk\doc\options.txt"
   with file "options-angbandtk.txt" (rename it to
   "options.txt" first) located in the "Files" directory.

4. Overwrite the file
   "OmnibandTk-1.4\variant\ZAngbandTk-240r5\tk\doc\options.txt"
   with file "options-zangbandtk.txt" (rename it to
   "options.txt" first) located in the "Files" directory.


============================================================
NOTES
============================================================
The "squelch_angbandtk-2_9_2r2-1_0.pat" and 
"squelch_zangbandtk-2_4_0r5-1_0.pat" patches create the file 
"squelch.c" so you'll need to modify your makefiles or
projects to include this in your builds.

-------------------
You'll need to run the "patch" commands from a unix console
or use a unix shell like Cygwin or something that supports
the unix diff command if you want to do it from a windows
environment.

-------------------
Save files created after applying the patches will use two
sections that were previously "reserved for future use".
I'm guessing this will cause a problem if in the future,
those sections become part of the general save functionality
so be aware.

-------------------
This patch uses the interface Tcl code that was created for
OAngbandTk.  One issue this introduces is that items like
potions and mushrooms and other things that are assigned
random graphics can be identified through the squelch by
type menu.  This is cheating.