/[wryebash]/branches/upstream-master/Readme.md
ViewVC logotype

Contents of /branches/upstream-master/Readme.md

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4 - (show annotations) (download)
Mon Sep 19 03:20:26 2016 UTC (3 years, 4 months ago) by william
File size: 5337 byte(s)
add upstream git branches for dev and master
1 Wrye Bash
2 =========
3
4 ###About
5
6 Wrye Bash is a mod management utility for Oblivion and Skyrim with a rich set
7 of features. This is a fork of the Wrye Bash related code from the
8 [SVN 3177 trunk revision][1].
9 We are in the process of refactoring the code to eventually support more
10 games, offering the same feature set for all of them.
11 Please read the [Contributing](#contributing) section below if interested in
12 contributing.
13
14 ###Download
15
16 * [Oblivion Nexus][2]
17 * [Skyrim Nexus][3]
18 * [Github][4] (all releases)
19
20 Docs are included in the download but we are setting them up also online
21 [here][5].
22
23 ###Installation
24
25 * Short version: just use the installer, and install everything to their
26 default locations.
27 * Long version: see the [General Readme][6] for information, and the
28 [Advanced Readme][7] for even more details.
29
30 To run Wrye Bash from the latest `dev` code (download from [here][8])
31 you need:
32
33 * A game to manage (currently Oblivion or Skyrim)
34 * [Python 2.7](http://www.python.org/) (latest 2.7 is recommended)
35 * [wxPython 2.8.12.1 Unicode][9] (do **not** get a newer version)
36 * [pywin32 build 218 or newer](https://sourceforge.net/projects/pywin32/files/pywin32/)
37 for your Python
38 * [comtypes 0.6.2 or later](https://sourceforge.net/projects/comtypes/files/comtypes/)
39 for your Python
40
41 **NB**: the 32-bit versions are required even if you are on a 64-bit
42 operating system.
43
44 Refer to the readmes for [detailed instructions][6]. In short:
45
46 1. Install one of the supported games (Oblivion, Skyrim).
47 2. Install Python and plugins above.
48 3. Extract the downloaded Wrye Bash archive into your game folder.
49 4. Run Wrye Bash by double-clicking "Wrye Bash Launcher.pyw" in the new Mopy
50 folder.
51
52 ####WINE
53
54 Wrye Bash 306 runs on WINE - with some hiccups. In short:
55
56 1. Do not use the installer - instead wine-install the python prerequisites
57 above, then unzip/clone the python version in your game folder
58 2. Edit `Mopy/bash/balt.py` - add `canVista = False` just above the
59 [`def setUAC(button_,uac=True):`][10] so it becomes
60
61 ```
62 ...
63 canVista = False
64 def setUAC(button_,uac=True):
65 ...
66 ```
67
68 3. Run Bash as `wine python /path/to/Mopy/Wrye Bash Launcher.pyw`
69
70 For details see our [wiki article][11].
71 Wine issue: [#240][12]
72
73
74 ###Contributing
75
76 To contribute to the code, fork the repo and set your fork up as
77 detailed in [\[git\] Syncing a Fork with the main repository][13].
78 A good starting point is the [currently worked on issues][14]
79 (see also [issue 200][15] for some refactoring tasks we need help with).
80 The recommended way to code for Bash is Pycharm ([set up instructions][16]).
81 Please also read at least:
82
83 * **[\[github\] Branching Model & Using The Repository][17]**
84 * **[\[github\] Branching and merging to dev using rebase][18]**
85 * **[\[dev\] Coding Style][19]**
86
87 When ready do not issue a pull request - contact instead a member of the team
88 in the relevant issue and let them review. Then those branches can be pulled
89 from your fork and integrated with upstream. Once this is done a couple times
90 you get write rights.
91
92 ####Main Branches
93
94 - [`dev`](https://github.com/wrye-bash/wrye-bash/tree/dev): the main development
95 branch - approved commits end up here. _Do not directly push to this branch_ -
96 push to your branches and contact someone from the owners team in the relevant
97 issue.
98 - [`master`](https://github.com/wrye-bash/wrye-bash/tree/master): the production
99 branch, contains stable releases. Use it _only_ as reference.
100 - [`utumno-wip`](https://github.com/wrye-bash/wrye-bash/tree/utumno-wip):
101 bleeding edge dev branch. Do have a look if interested in contributing or
102 testing very latest features/fixes.
103
104
105 [1]: http://sourceforge.net/p/oblivionworks/code/3177/tree/
106 [2]: http://www.nexusmods.com/oblivion/mods/22368/?tab=2&navtag=http%3A%2F%2Fwww.nexusmods.com%2Foblivion%2Fajax%2Fmodfiles%2F%3Fid%3D22368&pUp=1
107 [3]: http://www.nexusmods.com/skyrim/mods/1840/?tab=2&navtag=http%3A%2F%2Fwww.nexusmods.com%2Fskyrim%2Fajax%2Fmodfiles%2F%3Fid%3D1840&pUp=1
108 [4]: https://github.com/wrye-bash/wrye-bash/releases
109 [5]: http://wrye-bash.github.io/
110 [6]: http://wrye-bash.github.io/docs/Wrye%20Bash%20General%20Readme.html#install
111 [7]: http://wrye-bash.github.io/docs/Wrye%20Bash%20Advanced%20Readme.html#install
112 [8]: https://github.com/wrye-bash/wrye-bash/archive/dev.zip
113 [9]: http://sourceforge.net/projects/wxpython/files/wxPython/2.8.12.1/wxPython2.8-win32-unicode-2.8.12.1-py27.exe
114 [10]: https://github.com/wrye-bash/wrye-bash/blob/0a47238de9e7f46f55fe755f2744e2cea521f514/Mopy/bash/balt.py#L678
115 [11]: https://github.com/wrye-bash/wrye-bash/wiki/%5Bdev%5D-Running-Wrye-Bash-on-WINE-%28Arch-Linux%29
116 [12]: https://github.com/wrye-bash/wrye-bash/issues/240
117 [13]: https://github.com/wrye-bash/wrye-bash/wiki/%5Bgit%5D-Syncing-a-Fork-with-the-main-repository
118 [14]: https://github.com/wrye-bash/wrye-bash/issues?utf8=%E2%9C%93&q=sort%3Aupdated-desc%20is%3Aopen
119 [15]: https://github.com/wrye-bash/wrye-bash/issues/200
120 [16]: https://github.com/wrye-bash/wrye-bash/wiki/%5Bdev%5D-Set-up-Pycharm-for-wrye-bash
121 [17]: https://github.com/wrye-bash/wrye-bash/wiki/%5Bgithub%5D-Branching-Model-&-Using-The-Repository
122 [18]: https://github.com/wrye-bash/wrye-bash/wiki/%5Bgithub%5D-Branching-and-merging-to-dev-using-rebase
123 [19]: https://github.com/wrye-bash/wrye-bash/wiki/%5Bdev%5D-Coding-Style

  ViewVC Help
Powered by ViewVC 1.1.22