Guide:Wrye Bash: Difference between revisions

From Step Mods | Change The Game
Line 181: Line 181:
[[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 '''[General]''' tab gives an overview of the files recognized in the package as well as some useful statistics.
:::::::::::* The '''[General]''' tab gives an overview of the files recognized in the package as well as some useful statistics.
::::::::::::* The '''[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 '''[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 '''[Missing]''' tab should list all files in the package, since it is the exact reciprocal of the [Matched] tab.
:::::::::::* The '''[Missing]''' tab should list all files in the package, since it is the exact reciprocal of the [Matched] tab.
::::::::::::* The '''[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 '''[Show Inactive Conflicts]''' is unchecked, the '''[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 '''[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 '''[Show Inactive Conflicts]''' is unchecked, the '''[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 '''[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 '''[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.
::::::::::::** '''[Underridden]''' and '''[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.
:::::::::::** '''[Underridden]''' and '''[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 '''[Skipped]''' tab lists any files/folders that are not recognized by BAIN as "install-able". For some cases, this can be rectified by ticking '''[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 '''[Skipped]''' tab lists any files/folders that are not recognized by BAIN as "install-able". For some cases, this can be rectified by ticking '''[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 '''[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 '''[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''').
{{Sidebox|right|width=500|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.}}
{{Sidebox|right|width=500|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.}}



Revision as of 05:24, April 19, 2013

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

Updated: 5:24:03 19 April 2013 (UTC)

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.