Readme.md

Wrye Bash

###About

Wrye Bash is a mod management utility for Oblivion and Skyrim with a rich set of features. This is a fork of the Wrye Bash related code from the SVN 3177 trunk revision. We are in the process of refactoring the code to eventually support more games, offering the same feature set for all of them. Please read the Contributing section below if interested in contributing.

###Download

• Oblivion Nexus
• Skyrim Nexus
• Github (all releases)

Docs are included in the download but we are setting them up also online here.

###Installation

• Short version: just use the installer, and install everything to their default locations.
• Long version: see the General Readme for information, and the Advanced Readme for even more details.

To run Wrye Bash from the latest dev code (download from here) you need:

• A game to manage (currently Oblivion or Skyrim)
• Python 2.7 (latest 2.7 is recommended)
• wxPython 2.8.12.1 Unicode (do not get a newer version)
• pywin32 build 218 or newer for your Python
• comtypes 0.6.2 or later for your Python

NB: the 32-bit versions are required even if you are on a 64-bit operating system.

Refer to the readmes for detailed instructions. In short:

1. Install one of the supported games (Oblivion, Skyrim).
2. Install Python and plugins above.
3. Extract the downloaded Wrye Bash archive into your game folder.
4. Run Wrye Bash by double-clicking "Wrye Bash Launcher.pyw" in the new Mopy folder.

####WINE

Wrye Bash 306 runs on WINE - with some hiccups. In short:

1. Do not use the installer - instead wine-install the python prerequisites above, then unzip/clone the python version in your game folder
2. Edit Mopy/bash/balt.py - add canVista = False just above the def setUAC(button_,uac=True): so it becomes

...
canVista = False
def setUAC(button_,uac=True):
...

3. Run Bash as wine python /path/to/Mopy/Wrye Bash Launcher.pyw

For details see our wiki article. Wine issue: #240

###Contributing

To contribute to the code, fork the repo and set your fork up as detailed in [git] Syncing a Fork with the main repository. A good starting point is the currently worked on issues (see also issue 200 for some refactoring tasks we need help with). The recommended way to code for Bash is Pycharm (set up instructions). Please also read at least:

• [github] Branching Model & Using The Repository
• [github] Branching and merging to dev using rebase
• [dev] Coding Style

When ready do not issue a pull request - contact instead a member of the team in the relevant issue and let them review. Then those branches can be pulled from your fork and integrated with upstream. Once this is done a couple times you get write rights.

####Main Branches

• dev: the main development branch - approved commits end up here. Do not directly push to this branch - push to your branches and contact someone from the owners team in the relevant issue.
• master: the production branch, contains stable releases. Use it only as reference.
• utumno-wip: bleeding edge dev branch. Do have a look if interested in contributing or testing very latest features/fixes.