Guide:Wrye Bash: Difference between revisions

From Step Mods | Change The Game
No edit summary
m (Text replace - "{{Fc|" to "{{fc|")
Line 31: Line 31:
[[File:Figure1_SkyrimClean.jpg|thumb|right|450px|'''Figure 1:''' These are the only files that should appear in ''skyrim/''.]]
[[File:Figure1_SkyrimClean.jpg|thumb|right|450px|'''Figure 1:''' These are the only files that should appear in ''skyrim/''.]]
A clean Skyrim install establishes a baseline from which to begin the STEP installation procedure. The simplest way to ensure a clean Skyrim install is to delete all loose files (not directories) from the ''skyrim/'' directory (parent to Data directory), followed by cleaning out all files and directories from the Data directory ('''Figure 1''').
A clean Skyrim install establishes a baseline from which to begin the STEP installation procedure. The simplest way to ensure a clean Skyrim install is to delete all loose files (not directories) from the ''skyrim/'' directory (parent to Data directory), followed by cleaning out all files and directories from the Data directory ('''Figure 1''').
Once complete, open the Steam Libraries view, ''right'' click on Skyrim and select {{Fc|#e6b69e|'''[Properties]'''}}. Click on the {{Fc|#e6b69e|'''[LOCAL FILES]'''}} tab, then click on {{Fc|#e6b69e|'''[VERIFY INTEGRITY OF GAME CACHE...]'''}}. This will restore any missing files whilst avoiding the time-consuming and redundant download of the large files listed above. If ther is any uncertainty, uninstall and then reinstall Skyrim from scratch to this point.
Once complete, open the Steam Libraries view, ''right'' click on Skyrim and select {{fc|#e6b69e|'''[Properties]'''}}. Click on the {{fc|#e6b69e|'''[LOCAL FILES]'''}} tab, then click on {{fc|#e6b69e|'''[VERIFY INTEGRITY OF GAME CACHE...]'''}}. This will restore any missing files whilst avoiding the time-consuming and redundant download of the large files listed above. If ther is any uncertainty, uninstall and then reinstall Skyrim from scratch to this point.


=== Install File-Compression Software ===
=== Install File-Compression Software ===
Line 39: Line 39:
==== Install ====
==== Install ====
<ol><li>Download the Wrye Bash 300 (or current) [http://skyrim.nexusmods.com/downloads/file.php?id=1840 installer from the Nexus].</li>
<ol><li>Download the Wrye Bash 300 (or current) [http://skyrim.nexusmods.com/downloads/file.php?id=1840 installer from the Nexus].</li>
<li>Tick {{Fc|#e6b69e|'''[Skyrim]'''}} and {{Fc|#e6b69e|'''[Standalone]'''}}. ''Installing the Python version is also valid, but that methodology will not be supported in future versions of this guide.''</li>
<li>Tick {{fc|#e6b69e|'''[Skyrim]'''}} and {{fc|#e6b69e|'''[Standalone]'''}}. ''Installing the Python version is also valid, but that methodology will not be supported in future versions of this guide.''</li>
<li>'''Allow''' the installation of any dependencies if prompted.</li>
<li>'''Allow''' the installation of any dependencies if prompted.</li>
:: {{Fc|#e6b69e|If the installer is having trouble finding Skyrim ...}}
:: {{fc|#e6b69e|If the installer is having trouble finding Skyrim ...}}
::*Exit the installer, restart Steam, and run Skyrim from Steam. ''Doing this will create the necessary registry entries required for WB to find the installation directory.''
::*Exit the installer, restart Steam, and run Skyrim from Steam. ''Doing this will create the necessary registry entries required for WB to find the installation directory.''
<li>Delete the "Oblivion" directories from ''skyrim/Mopy/INI Tweaks'', ''skyrim/Mopy/Bash Patches'', and ''skyrim/Mopy/templates''.</li>
<li>Delete the "Oblivion" directories from ''skyrim/Mopy/INI Tweaks'', ''skyrim/Mopy/Bash Patches'', and ''skyrim/Mopy/templates''.</li>
Line 87: Line 87:


== Package Structure & Interpretation ==
== Package Structure & Interpretation ==
[[File:Figure3_BAINFirst.jpg|thumb|right|475px|'''Figure 3:''' Introduction to BAIN. (L to R) {{Fc|#ED1C24|'''Package Details'''}}, {{Fc|#4F58DC|'''Sub-Packages/Plugins'''}}, {{Fc|#22B14C|'''Comments'''}}]]
[[File:Figure3_BAINFirst.jpg|thumb|right|475px|'''Figure 3:''' Introduction to BAIN. (L to R) {{fc|#ED1C24|'''Package Details'''}}, {{fc|#4F58DC|'''Sub-Packages/Plugins'''}}, {{fc|#22B14C|'''Comments'''}}]]
The installers tab contains the package-management interface. Package management is a VERY important aspect of WB, and standards of Wrye '''BA'''sh '''IN'''staller (aka BAIN package or archive) structure represent the foundation of effectively using BAIN. Unfortunately, not all mod authors pack their mods in a BAIN-ready format, so it is important to understand how to convert to the proper structure. The good news is that BAIN has some flexibility, and usually can translate archives correctly. Packages preceded by a red (simple package), white (complex package) or gray (unrecognized) box are NOT installed (installed packages will have a plus [+] symbol inside the box). Before proceeding further, all packages must be made recognizable to BAIN (i.e., gray boxes and text must be eliminated). The following examples illustrate BAIN package interpretation and allude to some effective packing methods.
The installers tab contains the package-management interface. Package management is a VERY important aspect of WB, and standards of Wrye '''BA'''sh '''IN'''staller (aka BAIN package or archive) structure represent the foundation of effectively using BAIN. Unfortunately, not all mod authors pack their mods in a BAIN-ready format, so it is important to understand how to convert to the proper structure. The good news is that BAIN has some flexibility, and usually can translate archives correctly. Packages preceded by a red (simple package), white (complex package) or gray (unrecognized) box are NOT installed (installed packages will have a plus [+] symbol inside the box). Before proceeding further, all packages must be made recognizable to BAIN (i.e., gray boxes and text must be eliminated). The following examples illustrate BAIN package interpretation and allude to some effective packing methods.
*Clicking on an archive will bring up details about the package in the upper right frame ({{Fc|#ED1C24|'''red'''}} outline), as well as any sub-packages or plugins if present just below that ({{Fc|#4F58DC|'''blue'''}} outline), followed by a convenient area to type in some comments about the package ({{Fc|#22B14C|'''green'''}} outline).
*Clicking on an archive will bring up details about the package in the upper right frame ({{fc|#ED1C24|'''red'''}} outline), as well as any sub-packages or plugins if present just below that ({{fc|#4F58DC|'''blue'''}} outline), followed by a convenient area to type in some comments about the package ({{fc|#22B14C|'''green'''}} outline).
*A closer look at the package details of example packages 1-4 depicted in the package list of '''Figure 3''' reveals further detail:
*A closer look at the package details of example packages 1-4 depicted in the package list of '''Figure 3''' reveals further detail:
*Plugin filters and sub-packages can be seen just beneath the package details viewer (see {{Fc|#4F58DC|'''blue'''}} outline in '''Figure 3'''). Any BAIN-ready package selected that contains an ESM or ESP will list them under {{Fc|#e6b69e|"Esp/m Filter"}}. Complex BAIN packages will also list the folder names alphanumerically under {{Fc|#e6b69e|"Sup-Packages"}}. Details in '''Figure 6''' reference the '''Ex 1''' and '''Ex 5''' as in '''Figures 4 & 5'''.
*Plugin filters and sub-packages can be seen just beneath the package details viewer (see {{fc|#4F58DC|'''blue'''}} outline in '''Figure 3'''). Any BAIN-ready package selected that contains an ESM or ESP will list them under {{fc|#e6b69e|"Esp/m Filter"}}. Complex BAIN packages will also list the folder names alphanumerically under {{fc|#e6b69e|"Sup-Packages"}}. Details in '''Figure 6''' reference the '''Ex 1''' and '''Ex 5''' as in '''Figures 4 & 5'''.
{{Notice Small|In working with installer packages, it is useful to extract and repack large packages (i.e., > 500 MB packed) into non-solid archives. This format sacrifices a bit of compression ratio as a trade-off for a significant increase in extraction/compression speed, which can take a while for large packages containing many small files backed into a solid compression "block".}}
{{Notice Small|In working with installer packages, it is useful to extract and repack large packages (i.e., > 500 MB packed) into non-solid archives. This format sacrifices a bit of compression ratio as a trade-off for a significant increase in extraction/compression speed, which can take a while for large packages containing many small files backed into a solid compression "block".}}
{{Gallery
{{Gallery
Line 107: Line 107:
| colspan="3" | [[File:Figure4_BAINEx1-2.jpg|frame|center|'''Figure 4:''' Package Details.]]
| colspan="3" | [[File:Figure4_BAINEx1-2.jpg|frame|center|'''Figure 4:''' Package Details.]]
|-
|-
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{Fc|Gray|'''Ex 1. Standard files & folders.''' All files and directory structure are revealed. WB recognizes several typical Skyrim file types and folder names as well as folders installed by WB itself.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{fc|Gray|'''Ex 1. Standard files & folders.''' All files and directory structure are revealed. WB recognizes several typical Skyrim file types and folder names as well as folders installed by WB itself.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{Fc|Gray|'''Ex 2. Standard files & folders with extra, non-standard folders.''' There is an extra directory in this archive that is not recognized by WB, because it does not follow a standard naming convention.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{fc|Gray|'''Ex 2. Standard files & folders with extra, non-standard folders.''' There is an extra directory in this archive that is not recognized by WB, because it does not follow a standard naming convention.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{Fc|Gray|'''Ex 2. Standard files & folders with extra, non-standard folders (revealed).''' The files that were invisible to WB are detected if {{Fc|#e6b69e|"Has Extra Directories"}} is ticked in the context menu (right click any package to bring up the context menu).}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{fc|Gray|'''Ex 2. Standard files & folders with extra, non-standard folders (revealed).''' The files that were invisible to WB are detected if {{fc|#e6b69e|"Has Extra Directories"}} is ticked in the context menu (right click any package to bring up the context menu).}}
|}
|}
{| class="wikitable"
{| class="wikitable"
| colspan="3" | [[File:Figure5_BAINEx3-5.jpg|frame|center|'''Figure 5:''' More Package Details.]]
| colspan="3" | [[File:Figure5_BAINEx3-5.jpg|frame|center|'''Figure 5:''' More Package Details.]]
|-
|-
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{Fc|Gray|'''Ex 3. Standard files & folders (2 levels).''' This reveals the exact same contents ad in '''Ex 1''' previously; however, the directory structure includes another level represented by the Data directory. Many mods are packed this way, and WB understands them just fine and will install the package accordingly.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{fc|Gray|'''Ex 3. Standard files & folders (2 levels).''' This reveals the exact same contents ad in '''Ex 1''' previously; however, the directory structure includes another level represented by the Data directory. Many mods are packed this way, and WB understands them just fine and will install the package accordingly.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{Fc|Gray|'''Ex 4. Standard files & folders (3 levels).''' This is exactly the same as '''Ex 3''', but the Data directory is now beneath yet another parent directory. Unfortunately, WB stops looking for anything more than 2 folders deep at this time. Many mods come packed this way, and were not created by modders that are thoughtful of BAIN. This will need to be extracted and repack according to '''Ex 1''' or '''Ex 3'''.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{fc|Gray|'''Ex 4. Standard files & folders (3 levels).''' This is exactly the same as '''Ex 3''', but the Data directory is now beneath yet another parent directory. Unfortunately, WB stops looking for anything more than 2 folders deep at this time. Many mods come packed this way, and were not created by modders that are thoughtful of BAIN. This will need to be extracted and repack according to '''Ex 1''' or '''Ex 3'''.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{Fc|Gray|'''Ex 5. Two folders containing standard files & folders.''' All preceding examples have been of '''simple''' package structure. This is an example of a '''complex''' package structure. The contents of 00 Core are exactly the the same as in '''Ex 4''', but there the ‘01 Optional’ folder containing options (note the file names in the example). Complex package structures allow an additional level of organization.}}
| style="width:300px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{fc|Gray|'''Ex 5. Two folders containing standard files & folders.''' All preceding examples have been of '''simple''' package structure. This is an example of a '''complex''' package structure. The contents of 00 Core are exactly the the same as in '''Ex 4''', but there the ‘01 Optional’ folder containing options (note the file names in the example). Complex package structures allow an additional level of organization.}}
|}
|}
{| class="wikitable"
{| class="wikitable"
| colspan="2" | [[File:Figure6_BAINSubFilter.jpg|frame|center|'''Figure 6:''' Complex BAIN packages, Sub-Packages and Plugins.]]
| colspan="2" | [[File:Figure6_BAINSubFilter.jpg|frame|center|'''Figure 6:''' Complex BAIN packages, Sub-Packages and Plugins.]]
|-
|-
| style="width:275px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{Fc|Gray|'''Ex 1. Standard files & folders.''' This is a simple BAIN archive containing a single plugin, which (unlike other files in the archive) must be selected prior to install.}}
| style="width:275px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{fc|Gray|'''Ex 1. Standard files & folders.''' This is a simple BAIN archive containing a single plugin, which (unlike other files in the archive) must be selected prior to install.}}
| style="width:553px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{Fc|Gray|'''Ex 5. Two folders containing standard files & folders.''' This is a complex BAIN archive; therefore, it contains two directories as listed in the {{Fc|#e6b69e|"Sub-Packages"}} area, each of which contains recognized files and/or folders as listed in the package details above. As is indicated, selecting the 00 Core sub-package will direct BAIN to install those listed. Selecting also the 01 Options sub-package will add the highlighted optional files. Again, unlike other file types, plugins must be selected to flag specifically for install.}}
| style="width:553px; background-color: #252525; vertical-align:text-top; padding:0.5em 0.5em 0.5em 0.5em"| {{fc|Gray|'''Ex 5. Two folders containing standard files & folders.''' This is a complex BAIN archive; therefore, it contains two directories as listed in the {{fc|#e6b69e|"Sub-Packages"}} area, each of which contains recognized files and/or folders as listed in the package details above. As is indicated, selecting the 00 Core sub-package will direct BAIN to install those listed. Selecting also the 01 Options sub-package will add the highlighted optional files. Again, unlike other file types, plugins must be selected to flag specifically for install.}}
|}
|}


Line 132: Line 132:
::::::::::: Once the files have been downloaded, renamed and sorted by package, BAIN should resemble '''Figure 8'''.
::::::::::: Once the files have been downloaded, renamed and sorted by package, BAIN should resemble '''Figure 8'''.
::::::::: {{Notice Small|size=55|The image in these figures may not reflect STEP in its current format, as they were created using STEP v2.2.5}}
::::::::: {{Notice Small|size=55|The image in these figures may not reflect STEP in its current format, as they were created using STEP v2.2.5}}
::::::::::: The {{Fc|#e6b69e|"Order"}} column is of particular interest, as this column defines the installation hierarchy. Packages assigned to lower numbers are installed first; thus, ''files from lower-numbered packages will be overwritten by those from higher numbered packages where there is conflict''. Likewise, sub-packages work the same way: those with lower numeric prefixes will appear in the list first and thus, will be installed first, and conflicting files will be overwritten by those with higher numbers (sub-packages are sorted alphanumerically).
::::::::::: The {{fc|#e6b69e|"Order"}} column is of particular interest, as this column defines the installation hierarchy. Packages assigned to lower numbers are installed first; thus, ''files from lower-numbered packages will be overwritten by those from higher numbered packages where there is conflict''. Likewise, sub-packages work the same way: those with lower numeric prefixes will appear in the list first and thus, will be installed first, and conflicting files will be overwritten by those with higher numbers (sub-packages are sorted alphanumerically).
::::::::::: This guide will illustrate in detail how to set up STEP mods by focusing only on the initial texture mods. The same process may be used to set up all subsequent mods.
::::::::::: This guide will illustrate in detail how to set up STEP mods by focusing only on the initial texture mods. The same process may be used to set up all subsequent mods.
{{clear}}
{{clear}}
=== Set the Installation Order ===
=== Set the Installation Order ===
[[File:WB_Figure9.jpg|thumb|right|200px|'''Figure 9:''' Adjusting installation order of single mods or mod groups.]]
[[File:WB_Figure9.jpg|thumb|right|200px|'''Figure 9:''' Adjusting installation order of single mods or mod groups.]]
Because installation order is critical to get the results expected in game, the packages must be ordered properly according to install order such that the desired assets overwrite their conflicting assets. This is done by sorting BAIN installers by the {{Fc|#e6b69e|"Order"}} field. BAIN will handle every aspect of the hierarchy according to the preset install order, regardless of what packages are installed, saving the user a huge management headache and allowing the user to easily install/uninstall alternate conflicting assets.
Because installation order is critical to get the results expected in game, the packages must be ordered properly according to install order such that the desired assets overwrite their conflicting assets. This is done by sorting BAIN installers by the {{fc|#e6b69e|"Order"}} field. BAIN will handle every aspect of the hierarchy according to the preset install order, regardless of what packages are installed, saving the user a huge management headache and allowing the user to easily install/uninstall alternate conflicting assets.
[[File:WB_Figure10.jpg|thumb|left|200px|'''Figure 10:''' Final STEP Textures/Graphics load order.]]
[[File:WB_Figure10.jpg|thumb|left|200px|'''Figure 10:''' Final STEP Textures/Graphics load order.]]
&nbsp;
&nbsp;
::::::::::# Click on the {{Fc|#e6b69e|"Packages"}} column header to sort by package name. This will organize the mods according to the STEP Guide sections (if the packages have been named according to the Guide Section codes).
::::::::::# Click on the {{fc|#e6b69e|"Packages"}} column header to sort by package name. This will organize the mods according to the STEP Guide sections (if the packages have been named according to the Guide Section codes).
::::::::::# Multi-select the first (top) group of packages (Section D in this example), right click the highlighted selection, and select {{Fc|#e6b69e|"Move To"}}. Enter '0' if it is not already entered and select {{Fc|#e6b69e|'''[OK]'''}} (see '''Figure 9'''). The package list will not change, since BAIN is set to order by package ''name''; however, the order numbers ''will'' change.
::::::::::# Multi-select the first (top) group of packages (Section D in this example), right click the highlighted selection, and select {{fc|#e6b69e|"Move To"}}. Enter '0' if it is not already entered and select {{fc|#e6b69e|'''[OK]'''}} (see '''Figure 9'''). The package list will not change, since BAIN is set to order by package ''name''; however, the order numbers ''will'' change.
::::::::::# Select Section E packages, and repeat the previous step, but this time, enter into the {{Fc|#e6b69e|"Move To"}} dialogue the number equal to 1 + the highest Section D {{Fc|#e6b69e|"Order"}} number. Repeat this process for all Section groups.
::::::::::# Select Section E packages, and repeat the previous step, but this time, enter into the {{fc|#e6b69e|"Move To"}} dialogue the number equal to 1 + the highest Section D {{fc|#e6b69e|"Order"}} number. Repeat this process for all Section groups.
::::::::::# Left click on the {{Fc|#e6b69e|""Order"}} header to sort by package order. The new sort should cause a slight change in the package list order, but only within groups. Check to be certain that packages are now both ordered by increasing {{Fc|#e6b69e|""Order"}} number as well as that the package name groups are also in order (this is the STEP default, aside from a few exceptions as indicated by the order presented in the STEP Guide). If they are not, simply right click on the misbehaving package, and {{Fc|#e6b69e|"Move To"}} a position within its respective group and in that group's {{Fc|#e6b69e|Order"}} range.
::::::::::# Left click on the {{fc|#e6b69e|""Order"}} header to sort by package order. The new sort should cause a slight change in the package list order, but only within groups. Check to be certain that packages are now both ordered by increasing {{fc|#e6b69e|""Order"}} number as well as that the package name groups are also in order (this is the STEP default, aside from a few exceptions as indicated by the order presented in the STEP Guide). If they are not, simply right click on the misbehaving package, and {{fc|#e6b69e|"Move To"}} a position within its respective group and in that group's {{fc|#e6b69e|Order"}} range.
::::::::::# Once the installation order has been correctly set, the package list--when sorted on the [Order] column--should resemble '''Figure 10''' (but for a few of the exceptions in the lower part of Section D).{{clear}}
::::::::::# Once the installation order has been correctly set, the package list--when sorted on the [Order] column--should resemble '''Figure 10''' (but for a few of the exceptions in the lower part of Section D).{{clear}}
[[File:WB_Figure11.jpg|thumb|right|200px|'''Figure 11:''' Hiding installers.]]
[[File:WB_Figure11.jpg|thumb|right|200px|'''Figure 11:''' Hiding installers.]]
Line 150: Line 150:
At this point, the mod packages are ready to install. Begin by confirming that no unexpected or undesirable conflicts exist. Before doing this, it will be useful to 'hide' the packages that should not or cannot be installed. Doing so prevents these packages from being included in the conflicts viewer.
At this point, the mod packages are ready to install. Begin by confirming that no unexpected or undesirable conflicts exist. Before doing this, it will be useful to 'hide' the packages that should not or cannot be installed. Doing so prevents these packages from being included in the conflicts viewer.
# Select all of the obsolete packages, which should now be listed at the very end of the BAIN package list after the "==Last==" marker.
# Select all of the obsolete packages, which should now be listed at the very end of the BAIN package list after the "==Last==" marker.
# Right click on one of the selected packages and select {{Fc|#e6b69e|"Hide"}} from the context menu (confirm when prompted; see '''Figure 11''').{{clear|left}}
# Right click on one of the selected packages and select {{fc|#e6b69e|"Hide"}} from the context menu (confirm when prompted; see '''Figure 11''').{{clear|left}}
[[File:WB_Figure12.jpg|thumb|left|200px|'''Figure 12:''' Show inactive conflicts]]
[[File:WB_Figure12.jpg|thumb|left|200px|'''Figure 12:''' Show inactive conflicts]]
[[File:WB_Figure13.jpg|thumb|right|200px|'''Figure 13:''' View conflicts]]
[[File:WB_Figure13.jpg|thumb|right|200px|'''Figure 13:''' View conflicts]]
::::::::::: Select one of the installers, and examine the package details in the upper right frame of the BAIN window.
::::::::::: Select one of the installers, and examine the package details in the upper right frame of the BAIN window.
:::::::::::* The {{Fc|#e6b69e|'''[General]'''}} tab gives an overview of the files recognized in the package as well as some useful statistics.
:::::::::::* The {{fc|#e6b69e|'''[General]'''}} tab gives an overview of the files recognized in the package as well as some useful statistics.
:::::::::::* The {{Fc|#e6b69e|'''[Matched]'''}} tab should be empty, and will only list files with paths if there is a currently-installed file in the Data directory identical to any of the files that BAIN recognizes in the selected package.
:::::::::::* The {{fc|#e6b69e|'''[Matched]'''}} tab should be empty, and will only list files with paths if there is a currently-installed file in the Data directory identical to any of the files that BAIN recognizes in the selected package.
:::::::::::* The {{Fc|#e6b69e|'''[Missing]'''}} tab should list all files in the package, since it is the exact reciprocal of the [Matched] tab.
:::::::::::* The {{fc|#e6b69e|'''[Missing]'''}} tab should list all files in the package, since it is the exact reciprocal of the [Matched] tab.
:::::::::::* The {{Fc|#e6b69e|'''[Conflicts]'''}} tab is of special interest, because it will reveal actual conflicts OR potential conflicts according to a setting in BAIN’s main context menu. If {{Fc|#e6b69e|"Show Inactive Conflicts"}} is unchecked, the {{Fc|#e6b69e|'''[Conflicts]'''}} tab should be empty, so ensure that this setting is ticked to reveal potential conflicts ('''Figure 12'''), as no packages have been installed to this point.
:::::::::::* The {{fc|#e6b69e|'''[Conflicts]'''}} tab is of special interest, because it will reveal actual conflicts OR potential conflicts according to a setting in BAIN’s main context menu. If {{fc|#e6b69e|"Show Inactive Conflicts"}} is unchecked, the {{fc|#e6b69e|'''[Conflicts]'''}} tab should be empty, so ensure that this setting is ticked to reveal potential conflicts ('''Figure 12'''), as no packages have been installed to this point.
:::::::::::** Files and package {{Fc|#e6b69e|"Order"}} numbers that will be overwritten will be listed first under the "=Lower===" heading, and those that will overwrite the currently-selected mod will be listed under the "=Higher===" heading ('''Figure 13'''). In-game, assets listed under "=Higher===" will appear in game, so verify that the conflicts will resolve as desired.
:::::::::::** Files and package {{fc|#e6b69e|"Order"}} numbers that will be overwritten will be listed first under the "=Lower===" heading, and those that will overwrite the currently-selected mod will be listed under the "=Higher===" heading ('''Figure 13'''). In-game, assets listed under "=Higher===" will appear in game, so verify that the conflicts will resolve as desired.
:::::::::::** {{Fc|#e6b69e|'''[Underridden]'''}} and {{Fc|#e6b69e|'''[Dirty]'''}} tabs list assets in the currently-selected installer that are not installed due to being either superseded by the assets of a mod installed upstream or due to a file mismatch for some other reason (e.g., if the file has been altered after installation), respectively. Both should always be empty.
:::::::::::** {{fc|#e6b69e|'''[Underridden]'''}} and {{fc|#e6b69e|'''[Dirty]'''}} tabs list assets in the currently-selected installer that are not installed due to being either superseded by the assets of a mod installed upstream or due to a file mismatch for some other reason (e.g., if the file has been altered after installation), respectively. Both should always be empty.
:::::::::::** The {{Fc|#e6b69e|'''[Skipped]'''}} tab lists any files/folders that are not recognized by BAIN as "install-able". For some cases, this can be rectified by ticking {{Fc|#e6b69e|"Has Extra Directories"}} in BAIN's main context menu. If not, the file will need to be restructured within the installer if it should be installed.
:::::::::::** The {{fc|#e6b69e|'''[Skipped]'''}} tab lists any files/folders that are not recognized by BAIN as "install-able". For some cases, this can be rectified by ticking {{fc|#e6b69e|"Has Extra Directories"}} in BAIN's main context menu. If not, the file will need to be restructured within the installer if it should be installed.
:::::::::::** Check to be certain that any packages that have a white box preceding the package name have sub-packages selected as indicated in the middle frame on the right side of BAIN. Likewise, be certain that all necessary ESP/M Filters are also selected.
:::::::::::** Check to be certain that any packages that have a white box preceding the package name have sub-packages selected as indicated in the middle frame on the right side of BAIN. Likewise, be certain that all necessary ESP/M Filters are also selected.
:::::::::::** Once all packages have been verified and all necessary or optional adjustments made to the instllers, ALL packages may be selected at once and installed by right clicking one of the selected packages and clicking on {{Fc|#e6b69e|"Install"}}. This can also by done for each individual package and in any order, since the hierarchy has already been defined. Depending on computer hardware, this process could take only a minute or more than 10 minutes.
:::::::::::** Once all packages have been verified and all necessary or optional adjustments made to the instllers, ALL packages may be selected at once and installed by right clicking one of the selected packages and clicking on {{fc|#e6b69e|"Install"}}. This can also by done for each individual package and in any order, since the hierarchy has already been defined. Depending on computer hardware, this process could take only a minute or more than 10 minutes.
:::::::::::** Uninstallation is done in the same manner as installation, and all of the same rules apply.
:::::::::::** Uninstallation is done in the same manner as installation, and all of the same rules apply.
:::::::::::** Once installed, the boxes preceding package names will be either yellow or green, and each will have a '+' symbol, which indicates that the package is installed. Yellow means that the package has some file installed, but others have been overwritten by higher-order packages. Green means that all files of the package are installed without any overrides ('''Figure 14''').
:::::::::::** Once installed, the boxes preceding package names will be either yellow or green, and each will have a '+' symbol, which indicates that the package is installed. Yellow means that the package has some file installed, but others have been overwritten by higher-order packages. Green means that all files of the package are installed without any overrides ('''Figure 14''').
[[File:WB_Figure14.jpg|thumb|left|200px|'''Figure 14:''' Installed mods & Overwrites: before install]][[File:WB_Figure15.jpg|thumb|right|200px|'''Figure 15:''' Installed mods & Overwrites: after install]]
[[File:WB_Figure14.jpg|thumb|left|200px|'''Figure 14:''' Installed mods & Overwrites: before install]][[File:WB_Figure15.jpg|thumb|right|200px|'''Figure 15:''' Installed mods & Overwrites: after install]]
::::::::::: Infrequently, packages that are highlighted in yellow or orange have not been installed according to the defined heirarchy. This can easily be corrected by right clicking on the package and selecting {{Fc|#e6b69e|"Install Missing""}}. Afterwards, right click the package again and click {{Fc|#e6b69e|"Anneal"}} or {{Fc|#e6b69e|"Anneal All"}} to tell BAIN to consider all packages in the install list. The {{Fc|#e6b69e|"Anneal"}} function simply tells BAIN to refresh its assessment of the defined install hierarchy and reapply those rules to correct any unintended conflicts. It never hurts to use this function frequently, and {{Fc|#e6b69e|"Auto Anneal"}} should always be ticked in BAIN’s main context menu to honor the install hierarchy.
::::::::::: Infrequently, packages that are highlighted in yellow or orange have not been installed according to the defined heirarchy. This can easily be corrected by right clicking on the package and selecting {{fc|#e6b69e|"Install Missing""}}. Afterwards, right click the package again and click {{fc|#e6b69e|"Anneal"}} or {{fc|#e6b69e|"Anneal All"}} to tell BAIN to consider all packages in the install list. The {{fc|#e6b69e|"Anneal"}} function simply tells BAIN to refresh its assessment of the defined install hierarchy and reapply those rules to correct any unintended conflicts. It never hurts to use this function frequently, and {{fc|#e6b69e|"Auto Anneal"}} should always be ticked in BAIN’s main context menu to honor the install hierarchy.
::::::::::: Be strategic about the order in which things are installed and uninstalled, as any yellow-boxed package with a '+' symbol in it will need to be re-accessed by BAIN in order to install assets from higher-order mods that may be removed. If the overwritten package is very large (and 'solid'), it will significantly delay the uninstall of a conflicting downstream package being removed, regardless of the size of the package being removed. Even if the package being removed is being updated, then a lot of time can be saved by first positioning and ''installing'' the update, thus effectively 'blocking' the large, overwritten file from being accessed, since it will no longer be required for conflict resolution.
::::::::::: Be strategic about the order in which things are installed and uninstalled, as any yellow-boxed package with a '+' symbol in it will need to be re-accessed by BAIN in order to install assets from higher-order mods that may be removed. If the overwritten package is very large (and 'solid'), it will significantly delay the uninstall of a conflicting downstream package being removed, regardless of the size of the package being removed. Even if the package being removed is being updated, then a lot of time can be saved by first positioning and ''installing'' the update, thus effectively 'blocking' the large, overwritten file from being accessed, since it will no longer be required for conflict resolution.
::::::::::: Use the approach described thus far for setting up BAIN installers and installing the rest of STEP.
::::::::::: Use the approach described thus far for setting up BAIN installers and installing the rest of STEP.
{{clear}}
{{clear}}


= {{Fc|#641|'''Package Restructure'''}} =
= {{fc|#641|'''Package Restructure'''}} =
== BAIN-Repack Unrecognized Packages ==
== BAIN-Repack Unrecognized Packages ==
<ol>
<ol>
Line 220: Line 220:
</div>
</div>


= {{Fc|#641|'''Working With BCFs'''}} =
= {{fc|#641|'''Working With BCFs'''}} =
== BAIN "Package" Conversion Files ==
== BAIN "Package" Conversion Files ==
BCFs (BAIN Conversion Files) are very useful compressed instruction scripts that tell BAIN how to create BAIN-ready installers from BAIN-incompatible packages. Given that both source file(s) and converted BAIN version(s) exist, it is quite simple to create a BCF to make the task fast and easy for other downstream users.
BCFs (BAIN Conversion Files) are very useful compressed instruction scripts that tell BAIN how to create BAIN-ready installers from BAIN-incompatible packages. Given that both source file(s) and converted BAIN version(s) exist, it is quite simple to create a BCF to make the task fast and easy for other downstream users.
Line 229: Line 229:
# First, create the BAIN package ''manually'' from the unpacked source package(s). Refer to the second example in the previous section on "Package Restructure" using SRO.
# First, create the BAIN package ''manually'' from the unpacked source package(s). Refer to the second example in the previous section on "Package Restructure" using SRO.
# Place BOTH source package(s) and final BAIN-restructured package within ''Bash Installers/''.
# Place BOTH source package(s) and final BAIN-restructured package within ''Bash Installers/''.
# In BAIN, select the package(s) that were used as the source(s) of the resulting BAIN file, and right click to bring up the context menu (see '''Figure 9'''). Select {{Fc|#e6b69e|"Conversions"}} > {{Fc|#e6b69e|"Create"}}.
# In BAIN, select the package(s) that were used as the source(s) of the resulting BAIN file, and right click to bring up the context menu (see '''Figure 9'''). Select {{fc|#e6b69e|"Conversions"}} > {{fc|#e6b69e|"Create"}}.
# Select the BAIN package created in #1 when prompted (e.g., the SRO example described previously).
# Select the BAIN package created in #1 when prompted (e.g., the SRO example described previously).
# Select “OK” to the following pop-ups.
# Select “OK” to the following pop-ups.
# The results will be summarized, and the new BCF will be created in ''Bash Installers/Converters/''.
# The results will be summarized, and the new BCF will be created in ''Bash Installers/Converters/''.
Once a BCF is created, there is less value to retaining the original non-BAIN source packages. It is recommended that these be separated from the actual installers by selecting each source package, right click, select {{Fc|#e6b69e|"Move To"}}, and enter in a -1. This will move them to the bottom of the installation list when packages are later sorted by {{Fc|#e6b69e|"Order"}}. … More on this later in the guide ...
Once a BCF is created, there is less value to retaining the original non-BAIN source packages. It is recommended that these be separated from the actual installers by selecting each source package, right click, select {{fc|#e6b69e|"Move To"}}, and enter in a -1. This will move them to the bottom of the installation list when packages are later sorted by {{fc|#e6b69e|"Order"}}. … More on this later in the guide ...


{{Gallery
{{Gallery
Line 249: Line 249:
# Start WB and go to the Installers Tab (BAIN)
# Start WB and go to the Installers Tab (BAIN)
# Right-click on the mod (most likely at bottom of list)
# Right-click on the mod (most likely at bottom of list)
# Select {{Fc|#e6b69e|"Conversions"}} > {{Fc|#e6b69e|"Apply"}} > BCF.7z
# Select {{fc|#e6b69e|"Conversions"}} > {{fc|#e6b69e|"Apply"}} > BCF.7z
# Give the output BAIN package a name (accept the default)
# Give the output BAIN package a name (accept the default)
# Right-click the new package (most likely at bottom of list)
# Right-click the new package (most likely at bottom of list)
# Select {{Fc|#e6b69e|"Wizard"}}, and follow the instructions
# Select {{fc|#e6b69e|"Wizard"}}, and follow the instructions


= Mod Management =
= Mod Management =

Revision as of 21:03, December 14, 2014

Template:TOC right A simplified guide to using Wrye Bash to maintain a modded S.T.E.P. setup -- by z929669 & S.T.E.P. Team

GUIDE FORUM THREAD Template:Notice

[edit]

Wrye Nomenclature

Wrye was a prominent TES (The Elder Scrolls) enthusiast, modder and developer that created Wrye Bash as a tool to help other modders deal with the idiosyncrasies of modding for Oblivion (TES4). Wrye also later created an implementation that he called Wrye ‘Mash’ for Morrowind (TES3). Wrye Smash is simply Wrye ‘Bash’ implemented for Skyrim (TES5), so it IS Wrye Bash. For the sake of brevity and consistency, this guide will henceforth refer to Wrye Bash as ‘WB,’ and its analogues will likewise be referred to as ‘WS’ and ‘WM’ for Wrye Smash and Wrye Mash, respectively.

Purpose of This Guide

This guide assumes that the reader has reviewed the most updated relevant documentation now packaged with the WB program. If that is not the case, the authors strongly encourage a review of that documentation. Understanding--in a basic sense--what WB does and why it is useful are important concepts providing a context necessary for the reader to maximize the benefit of using this guide with respect to a fresh install of the most current major STEP (Skyrim Total Enhancement Project) release. Additionally, the guide will be modified and updated to reflect ongoing changes in each forthcoming major release of STEP. The novice WB user will likely find substantial value in following the guide as an actual working example of several sound techniques for implementing WB; nevertheless, much of the material covered in the following pages will be best understood with a baseline level of experience that exceeds “null” by at least a small margin, please familiarize yourself with the program before getting started.

Background - Basic Modding Principles

As with all TES games, modding Skyrim--in the most raw sense--can be accomplished by simply placing compatible files within the Steam/SteamApps/common/skyrim/Data/ directory (henceforth, referred to as “Data directory”). These files usually come packaged as a “mod” in an archive that facilitates simple decompression into the Data directory. Due to the vast number of mods and their incredible variety, the task of manual extraction and installation is a tedious process with lots of potential for error. Furthermore, it is difficult to “undo” what has been done, since it is difficult to keep track of the source of each file as the number of mods and files in the Data directory increases. One must take care to read each mod’s documentation to understand exactly what it does and how it does in in at least a very general sense. Why? Because it is important to create a customized Skyrim that suits the tastes of the individual modder. Strictly defined, two mods are compatible if they do not attempt to alter the same game variable. Likewise, two mods that affect the same game variable are strictly defined as incompatible, which is more often termed a conflict. Said variable could be a mesh or a texture as well as a plugin or INI file. Even a game setting affected by a plugin while also being altered by an INI setting or a configuration script represents a conflict. Under the strict definitions of mod compatibility and conflict, many mods are incompatible and thus, have conflicts. Fortunately, this is usually not really a problem, because most of the time, a conflict is inherently resolved by one mod “winning;” that is, one mod overwrites or overrides the other. For example, two particular versions of a texture file could attempt to occupy the same logical space in the Data/textures directory, in which case the second texture to be written to that space during installation will naturally overwrite the first. This is called a resource conflict. On the other hand, if one of those texture copies resides in a compressed BSA while the other exists as a “loose file,” then neither will physically overwrite the other upon installation, but rather one will override the other in-game upon execution of Skyrim. This is called a data conflict (also referred to as a load-order conflict).

The STEP Solution

One can spend hundreds of hours just searching for mods before actually getting down to the business of installing them. As mods increase in number and complexity and mod creators produce more and more mods that alter game play, interface and settings, the probability of game-crashing conflicts increases. The STEP project takes care of the heavy lifting associated with sifting through thousands of mods and selecting the ones that significantly enhance and improve the vanilla experience without detracting from it with as little cost as possible in terms of performance. Users are able to follow TheCompiler’s detailed, step-by-STEP manual-installation instructions and be confident that all components have been individually tested by the community and the results verified. STEP also facilitates customization by providing details of changes affected by each mod so that the user can choose to omit or change the order of STEP’s’. This cuts down on a vast amount of time and headache dealing with sampling, testing, troubleshooting, etc.

Limitations of STEP

Regardless of the huge time savings, efficiency boost and piece of mind that STEP offers, it is still a large manual process with many, well … steps. It can therefore take awhile, and problems can and will occur for many users with increasing frequency as mod numbers and complexity increase, so STEP will only go so far to reduce the job of maintaining a viable setup with each new mod or mod update. In order to allow better scalability of STEP as it evolves, it is necessary to simplify and condense the procedure into more manageable components. Mod organizers in general help in this regard by keeping track of files installed and package installation order. In particular WB enables the most configurable interface for mod management, and is thus the recommended choice for installing, configuring and maintaining the STEP setup with each new alteration in the mod configuration.