Guide:Wrye Bash: Difference between revisions
From Step Mods | Change The Game
No edit summary |
|||
Line 9: | Line 9: | ||
= Introduction = | = Introduction = | ||
== Wrye Nomenclature == | == 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. | 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 == | == 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 ([http://www.google.com/url?q=http%3A%2F%2Fskyrim.nexusmods.com%2Fdownloads%2Ffile.php%3Fid%3D11&sa=D&sntz=1&usg=AFQjCNH7aNfeQFzLwPgzhveYjpAQXyp2eA 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. | 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 ([http://www.google.com/url?q=http%3A%2F%2Fskyrim.nexusmods.com%2Fdownloads%2Ffile.php%3Fid%3D11&sa=D&sntz=1&usg=AFQjCNH7aNfeQFzLwPgzhveYjpAQXyp2eA 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 == | == 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. | 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. | ||
Line 27: | Line 23: | ||
=== The STEP Solution === | === 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. | 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 === | === 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. | 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. | ||
= Pre-installation | = Pre-installation = | ||
WB is not just simply a mod organizer but much, much more. Like other mod organizers, WB keeps track of mod packages as well as file sources and installation priority; however, WB goes far beyond this, some of which will be demonstrated throughout the rest of the guide. | WB is not just simply a mod organizer but much, much more. Like other mod organizers, WB keeps track of mod packages as well as file sources and installation priority; however, WB goes far beyond this, some of which will be demonstrated throughout the rest of the guide. | ||
== Set Up Skyrim & Supporting Software == | == Set Up Skyrim & Supporting Software == | ||
A much more comprehensive and in depth guide is available [[Guide:Skyrim Installation|Skyrim Installation Guide]]. | A much more comprehensive and in depth guide is available [[Guide:Skyrim Installation|Skyrim Installation Guide]]. | ||
=== Establish a Clean Skyrim Install === | === Establish a Clean Skyrim Install === | ||
[[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\''.]] | ||
Line 51: | Line 43: | ||
=== Install File-Compression Software === | === Install File-Compression Software === | ||
Almost any file-compression software can be used to view the contents of packages. 7-zip is favored by the authors, because it can produce dramatically smaller files than the other formats and it recognizes virtually every compression format. It's also free, open-source, and supports most of the other common formats. | Almost any file-compression software can be used to view the contents of packages. 7-zip is favored by the authors, because it can produce dramatically smaller files than the other formats and it recognizes virtually every compression format. It's also free, open-source, and supports most of the other common formats. | ||
=== Install & Configure Wrye Bash === | === Install & Configure Wrye Bash === | ||
==== 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 '''[Skyrim]''' and '''[Standalone]'''. ''Installing the Python version is also valid, but that methodology will not be supported in future versions of this guide.''</li> | <li>Tick '''[Skyrim]''' and '''[Standalone]'''. ''Installing the Python version is also valid, but that methodology will not be supported in future versions of this guide.''</li> | ||
Line 67: | Line 56: | ||
<li>That's it. WB is now very simple to install and keep up to date using the auto updater in the settings menu.</li></ol> | <li>That's it. WB is now very simple to install and keep up to date using the auto updater in the settings menu.</li></ol> | ||
====Configure==== | ==== Configure ==== | ||
If no previous backup of bash.ini is available, copy and then rename "bash_default.ini" to "bash.ini," and place this alongside the former. The INI defines many useful things including where WB looks for installers. The following edits may be useful:<br /> | If no previous backup of bash.ini is available, copy and then rename "bash_default.ini" to "bash.ini," and place this alongside the former. The INI defines many useful things including where WB looks for installers. The following edits may be useful:<br /> | ||
Line 81: | Line 69: | ||
=== Install BOSS === | === Install BOSS === | ||
[http://skyrim.nexusmods.com/downloads/file.php?id=6 Get BOSS from the Nexus] and install according the the instructions provided. You will be launching BOSS from Wrye Bash’s interface going forward. | [http://skyrim.nexusmods.com/downloads/file.php?id=6 Get BOSS from the Nexus] and install according the the instructions provided. You will be launching BOSS from Wrye Bash’s interface going forward. | ||
Line 87: | Line 74: | ||
= Using Wrye Bash = | = Using Wrye Bash = | ||
== BAIN (aka, Installers Tab) == | == BAIN (aka, Installers Tab) == | ||
The WB installer, "BAIN" (BAsh INstaller), is represented by the Installers Tab. BAIN is one of the most powerful interfaces of WB, as it boasts many handy features that no other mod organizer offers. Once all mod packages are placed within the ''Bash Installers'' directory, they will be recognized from within the BAIN interface where they can be arranged singly or in groups in any order, renamed, list markers added, conflicts detected, packages unpacked, installer wizards can be built and much more. | The WB installer, "BAIN" (BAsh INstaller), is represented by the Installers Tab. BAIN is one of the most powerful interfaces of WB, as it boasts many handy features that no other mod organizer offers. Once all mod packages are placed within the ''Bash Installers'' directory, they will be recognized from within the BAIN interface where they can be arranged singly or in groups in any order, renamed, list markers added, conflicts detected, packages unpacked, installer wizards can be built and much more. | ||
Line 97: | Line 83: | ||
== Launch Wrye Bash for the First Time == | == Launch Wrye Bash for the First Time == | ||
[[File:Figure2_LaunchFirst.jpg|450px|right|highslide:'''Figure 2:''' Wrye Bash will open to the '''Mods Tab''' by default.]] | [[File:Figure2_LaunchFirst.jpg|450px|right|highslide:'''Figure 2:''' Wrye Bash will open to the '''Mods Tab''' by default.]] | ||
Line 106: | Line 91: | ||
= BAIN Installers = | = BAIN Installers = | ||
=== Obtain the Mods === | === Obtain the Mods === | ||
Line 119: | Line 103: | ||
== 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'''}}]] | ||
Line 167: | Line 150: | ||
= Ex: Package Restructure = | = Ex: Package Restructure = | ||
== BAIN-Repack Unrecognized Packages == | == BAIN-Repack Unrecognized Packages == | ||
<ol> | <ol> | ||
<li>Begin by navigating to Bash ''Installers\'' and unpacking unrecognized packages into projects of same name in same location. Do the same for any packages that need modification according to TheCompiler’s advice.</li> | <li>Begin by navigating to Bash ''Installers\'' and unpacking unrecognized packages into projects of same name in same location. Do the same for any packages that need modification according to TheCompiler’s advice.</li> | ||
Line 220: | Line 201: | ||
</div> | </div> | ||
= Ex: | = Ex: 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. |
Revision as of 02:38, February 22, 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: 2:38:10 22 February 2013 (UTC)