What does Wrye Bash do?
- It makes it safe to try out new mods because it will restore everything to the way it was when you uninstall a mod
- It makes more mods compatible with each other by importing information from different mods into a "bashed patch"
- It allows you to exceed the 255 mod threshold by automatically merging mods for you
Spoiler
- What the heck do all these acronyms mean?
Yeah, to save typing, we often sling around terminology that can be confusing to newcomers. Here's a quick rundown of what we mean:- WB: Wrye Bash. Written in Python.
- WBSA: Wrye Bash Standalone. Wrye Bash packaged with the required Python interpreter and all dependencies into one neat executable package. Still internally runs on Python, but since the interpreter is internal to the exe, no Python components are required to be installed.
- PBash: A Bashed Patch built with the "classic" Python mode patchers. These patchers read, process, and write mod records all in Python.
- CBash: (1) A Bashed Patch built with the CBash (see #2) mode patchers. These patchers still do mod processing in Python, but utilize CBash.dll to do the file reading and writing.
- CBash: (2) A C++ written DLL with a C API, that is used for reading and writing ESP/ESM format files. This is the only part of Wrye Bash not written in Python (well, except for calls to 7z.exe to extract things).
- The practical benefits of using CBash are:
- Building the bashed patch is much faster
- More plugins are mergeable, giving you the ability to cram more goodness into Oblivion
- In the future, more interesting kinds of tweaks will be practical to implement
- Building the bashed patch is much faster
- BAIN: BAsh INstaller. You use it from the WB Installers tab
- BAIN archive: A mod released in a format that can be installed by BAIN
- BAIT: Bash Asynchronous Installer Tab. In development (pre-beta) and will replace the current implementation of BAIN. Will use multi-threading to have a UI that still responds while it processes data (calculates CRC's, installs mods, etc).
- WB: Wrye Bash. Written in Python.
Download: http://oblivion.nexusmods.com/mods/22368 (mirrored at http://www.fliggerty.com/phpBB3/viewtopic.php?f=54&t=4233 and, of course, https://sourceforge.net/projects/oblivionworks/files/Wrye%20Bash/)
Documentation:
- http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/Mopy/Docs/Wrye%20Bash%20General%20Readme.html (also included in the download as "Wrye Bash General Readme.html" in the Mopy folder)
- alt3rn1ty's http://oblivion.nexusmods.com/mods/35230 (For Oblivion, new guide for Skyrim pending)
- Metallicow's BAIN http://oblivion.nexusmods.com/mods/38857
- Translated documentation and guides: http://guides.tesfans.org/wrye%20bash/
Long version:
Spoiler
There are two versions available: the Python version and the Standalone version. They are functionally equivalent. Most people should run the Standalone version since it is slightly simpler (no external Python components to install). You should to install the Python version, however, if you want to be more involved with development or if you already have Python installed on your system for other reasons.
First, if you're using Windows XP, Wrye Bash needs the http://www.microsoft.com/download/en/details.aspx?id=14431 installed, the x86 version. This is required for the custom 7z executable that Wrye Bash uses to run. Later versions of Windows already have this installed.
If you're using the Standalone version, the only other thing you need to install manually is the http://www.microsoft.com/downloads/details.aspx?familyid=a5c84275-3b97-4ab7-a40d-3802b2af5fc2.
If you are using the Python version, dependency installation will be handled automatically by the installer. However, if you want or need to do things manually:
Remember! In Windows Vista and up, don't install Oblivion in the Program Files folder due to User Account Control! See File Permissions.There are two versions available: the Python version and the Standalone version. They are functionally equivalent. Most people should run the Standalone version since it is slightly simpler (no external Python components to install). You should to install the Python version, however, if you want to be more involved with development or if you already have Python installed on your system for other reasons.
First, if you're using Windows XP, Wrye Bash needs the http://www.microsoft.com/download/en/details.aspx?id=14431 installed, the x86 version. This is required for the custom 7z executable that Wrye Bash uses to run. Later versions of Windows already have this installed.
If you're using the Standalone version, the only other thing you need to install manually is the http://www.microsoft.com/downloads/details.aspx?familyid=a5c84275-3b97-4ab7-a40d-3802b2af5fc2.
If you are using the Python version, dependency installation will be handled automatically by the installer. However, if you want or need to do things manually:
Spoiler
Then:- http://www.python.org/ftp/python/2.7.3/python-2.7.3.msi
- http://sourceforge.net/projects/wxpython/files/wxPython/2.8.12.1/wxPython2.8-win32-unicode-2.8.12.1-py27.exe
- http://sourceforge.net/projects/comtypes/files/comtypes/0.6.2/comtypes-0.6.2.win32.exe/download
- http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win32-py2.7.exe/download
- Other setups may work, but this is the only officially supported setup.
- Python 3.x: NOT supported
- For manual installations of either the Standalone or Python versions, extract the archive in your Oblivion game folder so that the Mopy directory appears in the Oblivion directory
- For Python versions, run by double-clicking on Wrye Bash Launcher.pyw
- For WBSA (Wrye Bash StandAlone), run by double-clicking on Wrye Bash.exe
See Also http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/Mopy/Docs/Wrye%20Bash%20General%20Readme.html#trouble-permissions
Development:
The project is hosted at https://sourceforge.net/projects/oblivionworks/develop. You don't need a SourceForge account to create or add data to bug reports and feature requests -- you can always contribute anonymously (but put your name in the comments section if you want credit : ). Feeling brave? SVN versions are not guaranteed to be release quality, but if you know what you're doing and want to help us test new features and track down bugs, follow alt3rn1ty's SVN guide to use the latest code:
Spoiler
If going from Standalone version to Python version, use the latest installer to install the Python version before continuing. It will install all required dependencies for you.
The latest svn is always here >>http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/<< - Then just click "Download GNU Tarball" at the bottom. Note: If you have been told to try a specific revision number instead of the latest, type the revision number in the sticky revision box and press return, the Download GNU Tarball will now grab that revision's set of files.
Use >>http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/?view=log<< to view the log of changes for reference to specific revision numbers and their changes, to revert to as necessary if things go wrong...
A screenshot walkthrough:
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn1.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn2.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn3.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn4.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn5.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn6.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn7.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn8.jpg
Rinse and repeat when a new svn comes out.
Beware: Its a good idea to rename the tarball according to the revision number and keep it around. Keep a few weeks worth of them so if there is a problem found later with a particular set of committed files in the tarball you can go back to a previous known good revision. There's no need to go back this far but note svn revision 1309 was the directory structure change, and if you go back to a revision earlier than that you will probably have to follow http://www.gamesas.com/index.php?/topic/1205502-relz-wrye-bash/page__view__findpost__p__18000658 to get WB running again.
If going from Standalone version to Python version, use the latest installer to install the Python version before continuing. It will install all required dependencies for you.
The latest svn is always here >>http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/<< - Then just click "Download GNU Tarball" at the bottom. Note: If you have been told to try a specific revision number instead of the latest, type the revision number in the sticky revision box and press return, the Download GNU Tarball will now grab that revision's set of files.
Use >>http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/?view=log<< to view the log of changes for reference to specific revision numbers and their changes, to revert to as necessary if things go wrong...
A screenshot walkthrough:
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn1.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn2.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn3.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn4.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn5.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn6.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn7.jpg
http://oblivionworks.svn.sourceforge.net/viewvc/oblivionworks/Programs/Wrye%20Bash/screenshots/svn8.jpg
Rinse and repeat when a new svn comes out.
Beware: Its a good idea to rename the tarball according to the revision number and keep it around. Keep a few weeks worth of them so if there is a problem found later with a particular set of committed files in the tarball you can go back to a previous known good revision. There's no need to go back this far but note svn revision 1309 was the directory structure change, and if you go back to a revision earlier than that you will probably have to follow http://www.gamesas.com/index.php?/topic/1205502-relz-wrye-bash/page__view__findpost__p__18000658 to get WB running again.
Reporting Bugs: Try to give us enough information to diagnose your problem. The following information is useful to us:
Spoiler
- What version of Wrye Bash are you using? If you're using the SVN, be sure to include the revision number.
- What are all the symptoms? Be sure to include what you did (step-by-step is helpful), what you expected, and what happened.
- What do you see? Error messages are very valuable to us.
- What version of Windows are you using? Is UAC enabled and is Oblivion in the default directory? (If it is, please install it somewhere else. This can cause lots of problems)
- Are you using a bash.ini? If so, include its contents (in spoiler tags, please!)
- Is the problem related to the Bashed Patch? If so include the following:
- Your Load Order (in spoiler tags). Get this by right clicking on a column header in the Mods tab, and selecting 'List Mods...'
- Your Bashed Tags (in spoiler tags). Get this by right clicking on a column header in the Mods tab, and selecting 'List Bash Tags...'
- Your Bashed Patch config (in spoiler tags). Get this by right clicking on the Bashed Patch and selecting 'List Patch Config...'
- Your Load Order (in spoiler tags). Get this by right clicking on a column header in the Mods tab, and selecting 'List Mods...'
- If you're using the WBSA, things are a bit trickier. There are currently a few known issues:
- Wrye Bash wont work correctly if you launch it from the command line (DOS). Always launch by double clicking the exe or a shortcut to it.
- Due to issue #1, no debug mode is available. Some errors that happen will still be printed either to a "Wrye Bash.exe.txt" file, or to the "stdout/stderr" window that shows up with errors sometimes.
- Wrye Bash wont work correctly if you launch it from the command line (DOS). Always launch by double clicking the exe or a shortcut to it.
- If you think you've found an error in the WBSA, be sure to uninstall ALL python components and test it again first, to be sure we get an accurate report. Having python installed can sometimes trick the WBSA into thinking that it has all of the files it requires, even if it really doesn't.
Linking: If you'd like to link to Bash from somewhere else, please do! But be sure to link to either http://oblivion.nexusmods.com/mods/22368 or http://sourceforge.net/projects/oblivionworks/. Don't link to the actual download file, since that changes fairly frequently.
Related Projects:
- The Official http://www.gamesas.com/index.php?showtopic=1384740.
- Load orders should be managed with http://oblivion.nexusmods.com/mods/20516, which also supplies updated lists of tags used for importing (though even if you don't use BOSS, a basic taglist is shipped with each version of Wrye Bash)
- Valda ported and maintains Wrye Bash for Fallout3 (http://www.gamesas.com/index.php?showtopic=1211142) and Fallout3 New Vegas (http://www.gamesas.com/index.php?showtopic=1129389)
303 [2013/01/02] [Various community members]
Spoiler
- [Oblivion] Fixed issues with CBash saying that files don't exist during the patch building process. [Lojack]
- Uninstalling a mod in BAIN should no longer throw an error that the ESP/ESM could not be found if it was removed. [Lojack]
- Encoding format for INI Tweak files has been fixed. [Lokack]
- Typo corrections, unused variables, and other minor issues cleaned up. [Various]
- The bash_default.ini file has been cleaned up to remove unused entries and tidy up documentation. [Lojack]
- BAIN should now properly inform the user if an archive being installed is corrupted. [Lojack]
- Numerous changes have been made for better UAC support when installed on Vista, Windows 7, and Windows 8. (Note that Windows 8 is not yet officially supported but should still work.) [Lojack]
- BAIN should no longer leave behind empty folders when a mod is uninstalled. [Lojack]
- Better support for running Bash from within a folder containing Unicode characters. [Lojack]
- [Skyrim] Bash can now see string files inside of a BSA and will no longer mark mods with red bars because the files were not packaged loose. [Lojack]
- Bash will no longer throw errors if it encounters Nehrim.esm (the filename) in a Data folder not belonging to a Nehrim install. [Lojack]
- Updated the Windows icon used for Bash to something more visually appealing. [Wrinklyninja]
- Updated UI icon for BOSS. [Wrinklyninja]
- [Skyrim] Removed the non-functional inventory prompt tweak for buying and selling as Skyrim does not use the value. [Arthmoor]
- Deleting ghosted mods from the mods tab should no longer throw up errors about deleting the game's master files. [Lojack]
- Several updates to the documentation for Bash. [Lojack]