Wrye-Code-Collection
diff --git a/‎Mopy/Docs/Wrye Bash Advanced Readme.html‎
Lines changed: 2283 additions & 413 deletions b/‎Mopy/Docs/Wrye Bash Advanced Readme.html‎
Lines changed: 2283 additions & 413 deletions
diff --git a/‎Mopy/Docs/Wrye Bash General Readme.html‎
Lines changed: 17 additions & 12 deletions b/‎Mopy/Docs/Wrye Bash General Readme.html‎
Lines changed: 17 additions & 12 deletions
diff --git a/‎Mopy/bash/balt.py‎
Lines changed: 7 additions & 0 deletions b/‎Mopy/bash/balt.py‎
Lines changed: 7 additions & 0 deletions
diff --git a/‎Mopy/bash/basher/gui_patchers.py‎
Lines changed: 26 additions & 12 deletions b/‎Mopy/bash/basher/gui_patchers.py‎
Lines changed: 26 additions & 12 deletions
diff --git a/‎Mopy/bash/basher/mod_links.py‎
Lines changed: 4 additions & 3 deletions b/‎Mopy/bash/basher/mod_links.py‎
Lines changed: 4 additions & 3 deletions
diff --git a/‎Mopy/bash/bass.py‎
Lines changed: 0 additions & 6 deletions b/‎Mopy/bash/bass.py‎
Lines changed: 0 additions & 6 deletions
diff --git a/‎Mopy/bash/bosh/faces.py‎
Lines changed: 3 additions & 3 deletions b/‎Mopy/bash/bosh/faces.py‎
Lines changed: 3 additions & 3 deletions
@@ -694,31 +694,36 @@ <h3 id="patch-importing">Importing From Plugins <a class="back2top" href="#conte
 <table>
     <thead><tr><th>Section<th>Description<th>When You Should Use It
     <tbody>
-        <tr><td>Import Actors<td><em>Oblivion only.</em> Preserves changes made to actors (ie. NPCs and creatures) by the mods selected.<td>Always, unless you are told otherwise by a mod's readme.
-        <tr><td id="patchImportActorsAIPackages">Import Actors: AIPackages<td><em>Oblivion only.</em> Merges the changes made to actor AI packages by all the mods selected.<td>Always, unless you are told otherwise by a mod's readme.
-        <tr><td>Import Actors: Animations<td><em>Oblivion only.</em> Merges the changes made to actor animations by all the mods selected.<td>Always, unless you are told otherwise by a mod's readme.
-        <tr><td>Import Actors: Death Items<td><em>Oblivion only.</em> Preserves the changes made to the items added to an actor when it dies by the mods selected.<td>Always, unless you are told otherwise by a mod's readme.
-        <tr><td id="patchImportActorsSpells">Import Actors: Spells<td><em>Oblivion only.</em> Preserves the changes made to the spells actors have by the mods selected.<td>Always, unless you are told otherwise by a mod's readme.
+        <tr><td>Import Actors</td><td><em>All but Fallout 4.</em> Preserves changes made to actors (ie. NPCs and creatures) by the mods selected.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
+        <tr><td id="patchImportActorsAIPackages">Import Actors: AI Packages</td><td><em>All but Fallout 4.</em> Merges the changes made to actor AI packages by all the mods selected.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
+        <tr><td>Import Actors: Animations</td><td><em>Oblivion, Fallout 3 and Fallout&colon; New Vegas only.</em> Merges the changes made to actor animations by all the mods selected.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
+        <tr><td>Import Actors: Death Items</td><td><em>All but Fallout 4.</em> Preserves the changes made to the items added to an actor when it dies by the mods selected.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
+        <tr><td id="patchImportActorsSpells">Import Actors: Spells</td><td><em>All but Fallout 4.</em> Preserves the changes made to the spells actors have by the mods selected.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
         <tr><td id="patchImportCells">Import Cells<td><em>All but Fallout 4.</em> Preserves the changes made by the mods selected to cell settings such as lighting, climate, music, name, owner, water and more.<td>Always, unless you are told otherwise by a mod's readme.
+        <tr><td>Import Destructible</td><td><em>All but Oblivion and Fallout 4.</em> Preserves the changes made to the ability to destroy certain parts of the environment.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
         <tr><td>Import Factions<td><em>Oblivion, Fallout 3 and Fallout&colon; New Vegas only.</em> Preserves the changes made to the factions an actor belongs to by the mods selected.<td>Always, unless you are told otherwise by a mod's readme.
         <tr><td id="patchImportGraphics">Import Graphics<td><em>All but Fallout 4.</em> Preserves the changes made by the mods selected to various textures and models throughout the game.<td>The decision is entirely based on user preference. Choose whichever mods' graphics you prefer.
         <tr><td id="patchImportInventory">Import Inventory<td><em>All but Fallout 4.</em> Merges the changes made to the items in an actor's inventory by all the mods selected.<td>Always, unless you are told otherwise by a mod's readme.
-        <tr><td id="patchImportNPCFaces">Import NPC Faces<td><em>Oblivion only.</em> Preserves the changes made to NPC faces by the mods selected.<td>The decision is entirely based on user preference. Choose whichever mods' NPC faces you prefer.
+        <tr><td>Import Keywords</td><td><em>Skyrim and Skyrim&colon; Special Edition only.</em> Preserves the changes made to the keywords attached to various things throughout the game by the mods selected.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
+        <tr><td id="patchImportNPCFaces">Import NPC Faces</td><td><em>Oblivion, Fallout 3 &amp; Fallout&colon; New Vegas only.</em> Preserves the changes made to NPC faces by the mods selected.</td><td>The decision is entirely based on user preference. Choose whichever mods' NPC faces you prefer.</td>
         <tr><td id="patchImportNames">Import Names<td><em>All but Fallout 4.</em> Preserves the changes made to various names throughout the game by the mods selected.<td>The decision is entirely based on user preference. Choose whichever mods' names you prefer.
+        <tr><td>Import Object Bounds</td><td><em>All but Oblivion.</em> Preserves the changes made by the mods selected to the bounds of many types of objects throughout the world.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
         <tr><td id="patchImportRelations">Import Relations<td><em>Oblivion only.</em> Preserves the changes made by the mods selected to how factions interact.<td>Always, unless you are told otherwise by a mod's readme.
         <tr><td>Import Roads<td><em>Oblivion only.</em> Preserves the changes made by the mods selected to the landscape's roads.<td>Always, unless you are told otherwise by a mod's readme.
-        <tr><td>Import Scripts<td><em>Oblivion only.</em> Preserves the changes made by the mods selected to the scripts attached to things in the game.<td>Always, unless you are told otherwise by a mod's readme.
+        <tr><td>Import Scripts<td><em>Oblivion, Fallout 3 and Fallout&colon; New Vegas only.</em> Preserves the changes made by the mods selected to the scripts attached to things in the game.<td>Always, unless you are told otherwise by a mod's readme.
         <tr><td id="patchImportSounds">Import Sounds<td><em>All but Fallout 4.</em> Preserves the changes made by the mods selected to various sounds in the game.<td>The decision is entirely based on user preference. Choose whichever mods' sounds you prefer.
-        <tr><td id="patchImportSpellStats">Import Spell Stats<td><em>Oblivion only.</em> Preserves the changes made by the mods selected to items in order to fix bugs or rebalance them.<td>Always, unless you are told otherwise by a mod's readme. There is an element of user preference, for instance if you are using several mods that overhaul spell stats. In such cases, choose whichever mods' stats you prefer.
-        <tr><td>Import Stats<td><em>All but Fallout 4.</em> Preserves the changes made by the mods selected to spells in order to fix bugs or rebalance them.<td>Always, unless you are told otherwise by a mod's readme. There is an element of user preference, for instance if you are using several mods that overhaul item stats. In such cases, choose whichever mods' stats you prefer.
+        <tr><td id="patchImportSpellStats">Import Spell Stats</td><td><em>All but Fallout 4.</em> Preserves the changes made by the mods selected to spells / actor effects in order to fix bugs or rebalance them.</td><td>Always, unless you are told otherwise by a mod's readme. There is an element of user preference, for instance if you are using several mods that overhaul spell stats. In such cases, choose whichever mods' stats you prefer.</td></tr>
+        <tr><td>Import Stats<td><em>All but Fallout 4.</em> Preserves the changes made by the mods selected to items in order to fix bugs or rebalance them.<td>Always, unless you are told otherwise by a mod's readme. There is an element of user preference, for instance if you are using several mods that overhaul item stats. In such cases, choose whichever mods' stats you prefer.
+        <tr><td>Import Text</td><td><em>All but Fallout 4.</em> Preserves the changes made by the mods selected to various types of long-form text (e.g. text in a book, descriptions of armor, spells, weapons, etc.).</td><td>Always, unless you are told otherwise by a mod's readme. There is an element of user preference, for instance if you are using several mods that change book texts. In such cases, choose whichever mods' text you prefer.</td></tr>
+        <tr><td>Import Weapon Modifications</td><td><em>Fallout&colon; New Vegas only.</em> Merges the changes made by the mods selected to weapon modifications.</td><td>Always, unless you are told otherwise by a mod's readme.</td></tr>
 </table>
 
 <h3 id="patch-tweaking">Applying Tweaks <a class="back2top" href="#contents">Back to top</a></h3>
 <p>The Bashed Patch lets you independently tweak a large number of game settings. Each tweak has a description that is visible when you select it. Some tweaks have several possible values, with the current value given in [square brackets] in the tweak name. Right-clicking these tweaks will display a menu from which you can selected a different value. The tweaks are catagorised into different sections.
 <table>
     <thead><tr><th>Section<th>Description<th>When You Should Use It
     <tbody>
-        <tr><td id="patchTweakActors">Tweak Actors<td><em>Oblivion only.</em> Allows you to change a number of the game's settings relating to actors (ie. NPCs).<td>The decision is entirely based on user preference.
+        <tr><td id="patchTweakActors">Tweak Actors</td><td><em>All but Fallout 4.</em> Allows you to change a number of the game's settings relating to actors (i.e. NPCs).</td><td>The decision is entirely based on user preference.</td></tr>
         <tr><td id="patchTweakAssorted">Tweak Assorted<td><em>Oblivion only.</em> Contains a set of miscellaneous tweaks to the game.<td>The <strong>Bow Reach Fix</strong> and <strong>Nvidia Fog Fix</strong> are recommended for all users, as they fix bugs that may be uncovered by mods. The <strong>DarNified Books</strong> option is recommended for users of DarNified UI. Other than those, the decision is entirely based on user preference.
         <tr><td id="patchTweakClothes">Tweak Clothes<td><em>Oblivion only.</em> Contains a set of tweaks that changes settings relating to the game's clothing.<td>The decision is entirely based on user preference.
         <tr><td id="patchTweakNames">Tweak Names<td><em>Oblivion only.</em> Contains a set of tweaks that changes the names of things in the game. Most change the names to change how they are sorted in your inventory.<td>The decision is entirely based on user preference.
@@ -734,7 +739,7 @@ <h3 id="patch-other">Other Bashed Patch Options <a class="back2top" href="#conte
         <tr><td id="patchReplaceFormIDs">Replace Form IDs<td><em>Oblivion only.</em> Replaces a set of formIDs with another set of formIDs defined by a .csv file.<td>If you use a mod that tells you to use it.
         <tr><td id="patchCoblCatalogs">Cobl Catalogs<td><em>Oblivion only.</em> Updates Cobl's ingredient and effect catalogs to take into account those added by mods you use.<td>If you use Cobl (a.k.a. Common Oblivion).
         <tr><td>Cobl Exhaustion<td><em>Oblivion only.</em> Updates greater powers added by the mods that are listed in the selected .csv file options so that they're compatible with Cobl's Exhaustion feature.<td>If you use Cobl's Exhaustion feature.
-        <tr><td>Contents Checker<td><em>Oblivion only.</em> Checks that leveled lists and inventories contain the correct types of entries, and removes any incorrect entries.<td>Always.
+        <tr><td>Contents Checker</td><td><em>All but Fallout 4.</em> Checks that leveled lists, outfits, recipes and inventories contain the correct types of entries, and removes any incorrect entries.</td><td>Always.</td></tr>
         <tr><td id="patchLeveledLists">Leveled Lists<td>Merges changes made to leveled lists by mods to increase compatibility between them.<td>Always. If you don't have any mods that alter leveled lists, the option won't do anything, in which case it doesn't hurt to have it enabled.
         <tr><td id="patchMorphFactions">Morph Factions<td><em>Oblivion only.</em> Updates factions so that they are more likely to work with Wrye Morph.<td>If you use Cobl and Wrye Morph.
         <tr><td id="patchRaceRecords">Race Records<td><em>Oblivion only.</em> Some mods make changes to races and want those changes to be preserved even if another mod changes the same race. This ensures that those changes are kept. It also checks for and fixes various errors such as googly eyes and missing hair or eyes. It also has a section of race tweaks which the user can select as desired.<td>Always, even if there are no mods listed on the right.
@@ -1366,7 +1371,7 @@ <h3>Homage Credits <a class="back2top" href="#contents">Back to top</a></h3>
       <li><img alt="Woodman's Icon" src="../bash/images/bash_32_2.png"><span><a href="https://www.nexusmods.com/oblivion/mods/1840">Chase Camera</a> (<a href="https://www.nexusmods.com/users/85866">Woodman</a>)</span></li>
       <li><img alt="Tom Supergan's Icon" src="../bash/images/people/tomsavi32.png"><span>Chase Camera Distance (<a href="https://www.nexusmods.com/users/77237">Tom Supergan</a>)</span></li>
       <li><img alt="Compass Disable Icon" src="../bash/images/bash_32_2.png"><span>Compass Disable (??)</span></li>
-      <li><img alt="Compass POI Recognition Icon" src="../bash/images/bash_32_2.png"><span>Compass POI Recognition (??)</span></li>
+      <li><img alt="Compass Recognition Distance Icon" src="../bash/images/bash_32_2.png"><span>Compass Recognition Distance (??)</span></li>
       <li><img alt="Ravida's Icon" src="../bash/images/bash_32_2.png"><span>Fatigue from Running/Encumbrance (Ravida)</span></li>
       <li><img alt="Horse Turning Speed Icon" src="../bash/images/bash_32_2.png"><span>Horse Turning Speed (Acleacius, dbolivar)</span></li>
       <li><img alt="David Moyer's Icon" src="../bash/images/bash_32_2.png"><span>PC Death Camera (David Moyer)</span></li>
 
@@ -2472,8 +2472,15 @@ def AppendToMenu(self, menu, window, selection):
             menu = submenu
         for link in self.extraItems:
             link.AppendToMenu(menu, window, selection)
+        # After every 30 added items, add a break in the menu to avoid having
+        # to use the annoying wx scrolling feature (mostly affects the Bash
+        # Tags menu, since there are so many tags)
+        i = 1
         for link in (self.choiceLinkType(_text=txt) for txt in self._choices):
+            if i % 30 == 0:
+                menu.Break()
             link.AppendToMenu(menu, window, selection)
+            i += 1
         # returns None
 
 class TransLink(Link):
 
@@ -993,9 +993,6 @@ class NpcFacePatcher(importers.NpcFacePatcher, _ImporterPatcherPanel): pass
 class CBash_NpcFacePatcher(importers.CBash_NpcFacePatcher,
                            _ImporterPatcherPanel): pass
 
-class RoadImporter(importers.RoadImporter, _ImporterPatcherPanel): pass
-class CBash_RoadImporter(importers.CBash_RoadImporter, _ImporterPatcherPanel): pass
-
 class SoundPatcher(importers.SoundPatcher, _ImporterPatcherPanel): pass
 class CBash_SoundPatcher(importers.CBash_SoundPatcher, _ImporterPatcherPanel): pass
 
@@ -1014,6 +1011,12 @@ class DestructiblePatcher(importers.DestructiblePatcher, _ImporterPatcherPanel):
 
 class WeaponModsPatcher(importers.WeaponModsPatcher, _ImporterPatcherPanel): pass
 
+class KeywordsImporter(importers.KeywordsImporter, _ImporterPatcherPanel): pass
+
+class TextImporter(importers.TextImporter, _ImporterPatcherPanel): pass
+
+class ObjectBoundsImporter(importers.ObjectBoundsImporter, _ImporterPatcherPanel): pass
+
 # Patchers 30 -----------------------------------------------------------------
 class AssortedTweaker(multitweak_assorted.AssortedTweaker,
                       _TweakPatcherPanel): default_isEnabled = True
@@ -1074,15 +1077,26 @@ class CBash_ContentsChecker(special.CBash_ContentsChecker, _PatcherPanel):
 # scope
 from importlib import import_module
 gamePatcher = import_module('.patcher', ##: move in bush.py !
-                       package=bush.game_mod.__name__)
-for patcher_name, typeInfo in gamePatcher.gameSpecificPatchers.items():
-    globals()[patcher_name] = type(patcher_name, (typeInfo.clazz, _PatcherPanel), {})
-    if typeInfo.twinPatcher:
-        otherPatcherDict[patcher_name] = typeInfo.twinPatcher
-for patcher_name, typeInfo in gamePatcher.gameSpecificListPatchers.items():
-    globals()[patcher_name] = type(patcher_name, (typeInfo.clazz, _ListPatcherPanel), {})
-    if typeInfo.twinPatcher:
-        otherPatcherDict[patcher_name] = typeInfo.twinPatcher
+                            package=bush.game_mod.__name__)
+# Patchers with no options
+for patcher_name, p_info in gamePatcher.gameSpecificPatchers.items():
+    globals()[patcher_name] = type(
+        patcher_name, (p_info.clazz, _PatcherPanel), {})
+    if p_info.twinPatcher:
+        otherPatcherDict[patcher_name] = p_info.twinPatcher
+# Simple list patchers
+for patcher_name, p_info in gamePatcher.gameSpecificListPatchers.items():
+    globals()[patcher_name] = type(
+        patcher_name, (p_info.clazz, _ListPatcherPanel), {})
+    if p_info.twinPatcher:
+        otherPatcherDict[patcher_name] = p_info.twinPatcher
+# Import patchers
+for patcher_name, p_info in \
+        gamePatcher.game_specific_import_patchers.items():
+    globals()[patcher_name] = type(
+        patcher_name, (p_info.clazz, _ImporterPatcherPanel), {})
+    if p_info.twinPatcher:
+        otherPatcherDict[patcher_name] = p_info.twinPatcher
 
 del import_module
 
 
@@ -1563,17 +1563,18 @@ def Execute(self):
                     masterFile.load(True)
                     mapper = masterFile.getLongMapper()
                     for record in masterFile.SCPT.getActiveRecords():
-                        id_text[mapper(record.fid)] = record.scriptText
+                        id_text[mapper(record.fid)] = record.script_source
                 mapper = modFile.getLongMapper()
                 newRecords = []
                 for record in modFile.SCPT.records:
                     fid = mapper(record.fid)
                     #--Special handling for genericLoreScript
                     if (fid in id_text and record.fid == 0x00025811 and
-                        record.compiledSize == 4 and record.lastIndex == 0):
+                        record.compiled_size == 4 and record.last_index == 0):
                         removed.append(record.eid)
                         badGenericLore = True
-                    elif fid in id_text and id_text[fid] == record.scriptText:
+                    elif fid in id_text and id_text[fid] == \
+                            record.script_source:
                         removed.append(record.eid)
                     else:
                         newRecords.append(record)
 
@@ -32,12 +32,6 @@
 active_locale = None
 AppVersion = u"307" # must represent a valid float
 
-#--Null strings (for default empty byte arrays)
-null1 = '\x00'
-null2 = null1*2
-null3 = null1*3
-null4 = null1*4
-
 #--Global dictionaries - do _not_ reassign !
 # Bash's directories - values are absolute Paths - populated in initDirs()
 dirs = {}
 
@@ -22,13 +22,13 @@
 #
 # =============================================================================
 import re
-from .. import bass, bush, bolt
+from .. import bush, bolt
 from ..bolt import Flags, encode, sio, Path, struct_pack, struct_unpack
 from ..exception import SaveFileError, StateError
 from . import SaveInfo
 from ._saves import SreNPC, SaveFile
 from ..parsers import LoadFactory, ModFile, MasterMap
-from ..brec import getModIndex, MreRecord, genFid, RecordHeader
+from ..brec import getModIndex, MreRecord, genFid, RecordHeader, null2
 
 class PCFaces(object):
     """Package: Objects and functions for working with face data."""
@@ -46,7 +46,7 @@ def __init__(self):
             self.eid = self.pcName = u'generic'
             self.fggs_p = self.fgts_p = '\x00'*4*50
             self.fgga_p = '\x00'*4*30
-            self.unused2 = bass.null2
+            self.unused2 = null2
             self.health = self.unused3 = self.baseSpell = self.fatigue = self.level = 0
             self.skills = self.attributes = self.iclass = None
             self.factions = []