Skip to content

Commit a742a45

Browse files
committed
314 main readmes & version history
1 parent cbcba90 commit a742a45

7 files changed

Lines changed: 155 additions & 51 deletions

File tree

bash/images/people/thraavi32.png

2.53 KB
Loading

docs/Wrye Bash Advanced Readme.html

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@ <h3 id="install-alternate">Alternative Install Locations <a class="back2top" hre
182182
<h3 id="install-components">Python Components <a class="back2top" href="#contents">Back to top</a></h3>
183183
<p>If you are installing the Python version of Wrye Bash and wish to install the Python dependencies separately, the following must be installed.</p>
184184
<p class="emphasis">Note that the 64-bit versions are <em>required</em> - we no longer support 32-bit operating systems.</p>
185-
<p><a href="https://www.python.org">Python 3.12</a>: Versions prior to this one or newer than this one may work with Wrye Bash,
186-
but have not been tested. Updating to the latest 3.12 release is recommended for bug and security fixes.</p>
185+
<p><a href="https://www.python.org">Python 3.11</a>: Versions prior to this one or newer than this one may work with Wrye Bash,
186+
but have not been tested. Updating to the latest 3.11 release is recommended for bug and security fixes.</p>
187187
<p>Installation is easiest by just using pip, which comes with Python (see above). Simply run <code>path/to/python.exe -m pip install -r requirements.txt</code>
188188
(obviously replacing <code>path/to/python.exe</code> with the actual path to your python.exe).</p>
189189
<p>If you want to do it manually, the rest of this section will list out each
@@ -676,10 +676,10 @@ <h4>Example usage scenarios</h4>
676676
it may only be possible to do so via running an executable. In this
677677
situation, Wrye Bash can capture the installer's output, which you can
678678
then manage like any other package via BAIN.</li>
679-
<li><strong>Other Mod Managers</strong> - While Wrye Bash supports the
680-
FOMOD XML format since 307, there are still some badly packaged mods it
681-
cannot handle. In such situations, you may have to use other mod
682-
managers to install them.</li>
679+
<li><strong>Other Mod Managers</strong> - While Wrye Bash supports all
680+
FOMODs properly since 312, there are other mod formats like OMODs (used
681+
in Oblivion) that Wrye Bash only has limited support for. You may wish
682+
to capture the output of OBMM or similar tools in that case.</li>
683683
</ul>
684684

685685
<h4>How to use the "Monitor External Installation" feature</h4>
@@ -718,9 +718,7 @@ <h4>Usage Notes</h4>
718718
</li>
719719
<li>If you use Mod Organiser (or any mod manager that utilises a virtual installation of files instead of actually installing them into
720720
Data\), then Monitor External Installation can only be used if Wrye Bash is launched by the other Mod manager so that it will feed
721-
Wrye Bash the files it needs from the virtual folder. See <a
722-
href="https://github.com/wrye-bash/wrye-bash/wiki/Wrye-Bash-and-Mod-Organizer" target="_blank">this wiki article</a> for
723-
more information on integrating Wrye Bash with Mod Organizer.
721+
Wrye Bash the files it needs from the virtual folder.
724722
</li>
725723
<li>When installing mods via Nexus Mod Manager, it is recommended that you start monitoring, install the mod via NMM, then before
726724
closing NMM, complete the monitoring session. Create the BAIN package, then switch back to NMM and uninstall the mod. You can then
@@ -2262,12 +2260,12 @@ <h3 id="mods-commands">Context Menu Commands <a class="back2top" href="#contents
22622260
first activate as many non-mergeable plugins, according to
22632261
load order, as possible. If that would result in &gt;255
22642262
active plugins (&gt;254 non-ESLs for games with ESL
2265-
support) or &gt;4096 active ESLs, an error is shown. For
2266-
games without ESL support, if there is still space for
2267-
active plugins afterwards, it will next activate as many
2268-
mergeable plugins, according to load order, as possible. If
2269-
that would result in &gt;255 active plugins, an info popup
2270-
is shown.</td>
2263+
support) or &gt;4096 active ESLs, an error is shown, but as many
2264+
plugins as possible are activated (see <a href="#mods-undo">Undo</a>).
2265+
It will next activate as many mergeable plugins, according to load order,
2266+
as possible. If that would result in too many active plugins, an info
2267+
popup is shown.
2268+
</td>
22712269
</tr>
22722270
<tr>
22732271
<td>Activate Non-Mergeable</td>
@@ -12837,7 +12835,7 @@ <h3 id="tools-arguments">Command Line Arguments <a class="back2top" href="#conte
1283712835
</div>
1283812836

1283912837
<div id="footer">
12840-
<div id="version">Wrye Bash v313</div>
12838+
<div id="version">Wrye Bash v314</div>
1284112839
<a href="Wrye Bash General Readme.html">General</a>&#160;&#x2726;&#160;Advanced&#160;&#x2726;&#160;<a href="Wrye Bash Technical Readme.html">Technical</a>&#160;&#x2726;&#160;<a href="Wrye Bash Version History.html">Versions</a>
1284212840
<div id="oldie">Javascript disabled, menu and slideshows nonfunctional.</div>
1284312841
</div>

docs/Wrye Bash General Readme.html

Lines changed: 129 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -124,27 +124,82 @@ <h2 id="intro">Introduction <a class="back2top" href="#contents">Back to top</a>
124124
<li>And many, many more
125125
</ul>
126126
<p>It currently supports the following games:</p>
127-
<ul>
128-
<li>Enderal&colon; Forgotten Stories (Steam version)</li>
129-
<li>Enderal&colon; Forgotten Stories&colon; Special Edition (GOG and Steam
130-
versions)</li>
131-
<li>Fallout 3 (Epic Games Store, GOG, Steam and Windows Store
132-
versions)</li>
133-
<li>Fallout 4 (GOG, Steam and Windows Store versions)</li>
134-
<li>Fallout 4 VR (Steam version)</li>
135-
<li>Fallout&colon; New Vegas (Epic Games Store, GOG, Steam and Windows
136-
Store versions)</li>
137-
<li>Morrowind (very early support; GOG, Steam and Windows Store
138-
versions)</li>
139-
<li>Nehrim&colon; At Fate's Edge (GOG and Steam versions)</li>
140-
<li>Oblivion (GOG, Steam and Windows Store versions)</li>
141-
<li>Skyrim (Steam version)</li>
142-
<li>Skyrim&colon; Special Edition (Epic Games Store, GOG, Steam and Windows
143-
Store versions)</li>
144-
<li>Skyrim VR (Steam version)</li>
145-
<li>Starfield (WIP due to modding support not being enabled yet; Steam and
146-
Windows Store versions)</li>
147-
</ul>
127+
<table>
128+
<thead>
129+
<tr>
130+
<th>Supported Game</th>
131+
<th>Supported Versions</th>
132+
<th>Notes</th>
133+
</tr>
134+
</thead>
135+
<tbody>
136+
<tr>
137+
<td>Enderal&colon; Forgotten Stories</td>
138+
<td>Steam</td>
139+
<td></td>
140+
</tr>
141+
<tr>
142+
<td>Enderal&colon; Forgotten Stories&colon; Special Edition</td>
143+
<td>GOG, Steam</td>
144+
<td></td>
145+
</tr>
146+
<tr>
147+
<td>Fallout 3</td>
148+
<td>Disc/Retail, Epic Games Store, GOG, Steam, Windows Store</td>
149+
<td></td>
150+
</tr>
151+
<tr>
152+
<td>Fallout 4</td>
153+
<td>GOG, Steam, Windows Store</td>
154+
<td></td>
155+
</tr>
156+
<tr>
157+
<td>Fallout 4 VR</td>
158+
<td>Steam</td>
159+
<td></td>
160+
</tr>
161+
<tr>
162+
<td>Fallout&colon; New Vegas</td>
163+
<td>Epic Games Store, GOG, Steam, Windows Store</td>
164+
<td></td>
165+
</tr>
166+
<tr>
167+
<td>Morrowind</td>
168+
<td>Disc/Retail, GOG, Steam, Windows Store</td>
169+
<td>Very early support</td>
170+
</tr>
171+
<tr>
172+
<td>Nehrim&colon; At Fate's Edge</td>
173+
<td>GOG, Steam</td>
174+
<td></td>
175+
</tr>
176+
<tr>
177+
<td>Oblivion</td>
178+
<td>Disc/Retail, GOG, Steam, Windows Store</td>
179+
<td></td>
180+
</tr>
181+
<tr>
182+
<td>Skyrim</td>
183+
<td>Steam</td>
184+
<td></td>
185+
</tr>
186+
<tr>
187+
<td>Skyrim&colon; Special Edition</td>
188+
<td>Epic Games Store, GOG, Steam, Windows Store</td>
189+
<td></td>
190+
</tr>
191+
<tr>
192+
<td>Skyrim VR</td>
193+
<td>Steam</td>
194+
<td></td>
195+
</tr>
196+
<tr>
197+
<td>Starfield</td>
198+
<td>Steam, Windows Store</td>
199+
<td>WIP, only partially supported</td>
200+
</tr>
201+
</tbody>
202+
</table>
148203
<p>Wrye Bash can appear daunting at first. To help make it more manageable, the documentation has been split into a few readmes that are targeted towards different usage requirements.
149204
<p>This readme covers only the most commonly used features, so that the average user can start using Wrye Bash without being overwhelmed. Information on the less commonly used features and more technical details of the features covered in this readme may be found in the <a href="Wrye%20Bash%20Advanced%20Readme.html">Advanced Readme</a>. Information on some of the syntaxes and file formats that Wrye Bash uses are found in the <a href="Wrye%20Bash%20Technical%20Readme.html">Technical Readme</a>. Finally, Wrye Bash's version history is stored in the <a href="Wrye%20Bash%20Version%20History.html">Version History</a> document.</p>
150205

@@ -514,8 +569,9 @@ <h3 id="bain-structure">BAIN-Compatible installer layout <a class="back2top" hre
514569
<td>Skyrim</td>
515570
<td>asi, autobody, calientetools, dialogueviews,
516571
dragonbornvoiceover, dyndolod, flm, grass, interface, kreate,
517-
lodsettings, mapmarkers, mapweathers, mcm, mlq, nemesis_engine,
518-
netscriptframework, osa, platform, scripts, seasons, seq,
572+
lightplacer, lodsettings, mapmarkers, mapweathers, mcm, mlq,
573+
nemesis_engine, netscriptframework, osa, pbrmaterialobjects,
574+
pbrnifpatcher, pbrtexturesets, platform, scripts, seasons, seq,
519575
shaders, shadersfx, skse, skyproc patchers, slanims, strings,
520576
tools</td>
521577
</tr>
@@ -781,13 +837,51 @@ <h3 id="bain-symbols">What Symbols &amp; Colours Mean <a class="back2top" href="
781837
</tbody>
782838
</table>
783839
<table>
784-
<thead><tr><th>Text Formatting<th>Meaning
840+
<thead>
841+
<tr>
842+
<th>Text Formatting</th>
843+
<th>Meaning</th>
844+
</tr>
845+
</thead>
785846
<tbody>
786-
<tr><td class="bain-symbols-blutxt">Navy Blue<td>The package contains sub-packages.
787-
<tr><td class="bain-symbols-grytxt">Grey<td>BAIN does not recognise the structure of this package so cannot install it.
788-
<tr><td class="bain-symbols-orgbg">Orange Background<td>The install is dirty. This will occur for packages for which the configuration has been altered (either by altering active sub-packages and esmps, or by altering the package itself). This can be repaired by running <a href="#bainAnneal">Anneal</a> or <a href="#bainAnnealAll">Anneal All</a>.
789-
<tr><td class="bain-symbols-ylwbg">Yellow Background<td>The package has "underrides" i.e. some of its installed files <em>should</em> be overridden by higher order packages. This may happen after reordering mods that have already been installed. It can be repaired by running <a href="#bainAnneal">Anneal</a> or <a href="#bainAnnealAll">Anneal All</a>.
790-
<tr><td class="bain-symbols-grybg">Grey Background<td>Some files present in the package will <em><strong>not</strong></em> be installed. This can be due to having a complicated structure only partially handled by BAIN, or having file types that BAIN skips. This can sometimes be fixed by telling BAIN that the package has extra directories by selecting <a href="Wrye%20Bash%20Advanced%20Readme.html#bainHasExtraDirectories"></a> in the right-click menu.
847+
<tr>
848+
<td class="bain-symbols-blutxt">Navy Blue</td>
849+
<td>The package contains sub-packages.</td>
850+
</tr>
851+
<tr>
852+
<td class="bain-symbols-grytxt">Grey</td>
853+
<td>BAIN does not recognise the structure of this package and so
854+
cannot install it.</td>
855+
</tr>
856+
<tr>
857+
<td class="bain-symbols-orgbg">Orange Background</td>
858+
<td>The install is dirty. This will occur for packages for which
859+
the configuration has been altered (either by altering active
860+
sub-packages and esmps, or by altering the package itself).
861+
This can be repaired by running
862+
<a href="#bainAnneal">Anneal</a> or
863+
<a href="#bainAnnealAll">Anneal All</a>.</td>
864+
</tr>
865+
<tr>
866+
<td class="bain-symbols-ylwbg">Yellow Background</td>
867+
<td>The package has "underrides" i.e. some of its installed files
868+
<em>should</em> be overridden by higher order packages, but
869+
aren't. This may happen after reordering mods that have already
870+
been installed. It can be repaired by running
871+
<a href="#bainAnneal">Anneal</a> or
872+
<a href="#bainAnnealAll">Anneal All</a>.</td>
873+
</tr>
874+
<tr>
875+
<td class="bain-symbols-grybg">Grey Background</td>
876+
<td>Some files present in the package will <strong>not</strong> be
877+
installed. This can be due to having a complicated structure
878+
only partially handled by BAIN, or having file types that BAIN
879+
skips. This can sometimes be fixed by telling BAIN that the
880+
package has extra directories by selecting
881+
<a href="Wrye%20Bash%20Advanced%20Readme.html#bainHasExtraDirectories">Has Extra Directories</a>
882+
in the right-click menu.</td>
883+
</tr>
884+
</tbody>
791885
</table>
792886

793887
<h3 id="bain-commands">Useful Context Menu Commands <a class="back2top" href="#contents">Back to top</a></h3>
@@ -2635,7 +2729,7 @@ <h4>
26352729
<li>
26362730
<h4>
26372731
<img class="smallcred" alt="Flag of Brazil" src="../bash/images/flags/brazil.svg">
2638-
Portuguese (Brazil):
2732+
Brazilian Portuguese:
26392733
</h4>
26402734
<ul>
26412735
<li>
@@ -2646,6 +2740,10 @@ <h4>
26462740
<img class="smallcred" alt="TheBronn's Icon" src="../bash/images/people/thbravi32.png">
26472741
<span><a href="https://github.com/TheBronn">TheBronn</a></span>
26482742
</li>
2743+
<li>
2744+
<img class="smallcred" alt="Thiago Ramos's Icon" src="../bash/images/people/thraavi32.png">
2745+
<span><a href="https://github.com/thiagojramos">Thiago Ramos</a></span>
2746+
</li>
26492747
</ul>
26502748
</li>
26512749
<li>
@@ -2931,7 +3029,7 @@ <h2 id="advanced">Advanced Readme Topics <a class="back2top" href="#contents">Ba
29313029
</div>
29323030

29333031
<div id="footer">
2934-
<div id="version">Wrye Bash v313</div>
3032+
<div id="version">Wrye Bash v314</div>
29353033
General&#160;&#x2726;&#160;<a href="Wrye Bash Advanced Readme.html">Advanced</a>&#160;&#x2726;&#160;<a href="Wrye Bash Technical Readme.html">Technical</a>&#160;&#x2726;&#160;<a href="Wrye Bash Version History.html">Versions</a>
29363034
<div id="oldie">Javascript disabled, menu and slideshows nonfunctional.</div>
29373035
</div>

docs/Wrye Bash Technical Readme.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1465,7 +1465,7 @@ <h4>Example File</h4>
14651465
</div>
14661466

14671467
<div id="footer">
1468-
<div id="version">Wrye Bash v313</div>
1468+
<div id="version">Wrye Bash v314</div>
14691469
<a href="Wrye Bash General Readme.html">General</a>&#160;&#x2726;&#160;<a href="Wrye Bash Advanced Readme.html">Advanced</a>&#160;&#x2726;&#160;Technical&#160;&#x2726;&#160;<a href="Wrye Bash Version History.html">Versions</a>
14701470
<div id="oldie">Javascript disabled, menu and slideshows nonfunctional.</div>
14711471
</div>

docs/Wrye Bash Version History.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@
3535

3636
<p class="history-veranc">All versions by Wrye unless otherwise noted.
3737

38+
<h3>314 Mini-Release for MO2 [2025/04/05] [Various community members]</h3>
39+
<ul>
40+
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/697">#697</a>: Clean Data fails with an error when moving files [Utumno]</li>
41+
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/694">#694</a>: Wrye Bash fails to extract faces from saves in Oblivion [Utumno]</li>
42+
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/689">#689</a>: Work around MO2&#x27;s VFS breaking newer versions of WB [Infernio]</li>
43+
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/580">#580</a>: Improve handling of renames, fix bugs [Utumno]</li>
44+
</ul>
45+
3846
<h3>313 Translations rework [2024/12/21] [Various community members]</h3>
3947
<ul>
4048
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/685">#685</a>: Add ability to import/export load order [Infernio]</li>
@@ -4377,7 +4385,7 @@ <h3>0.01 [2006/04/13]</h3>
43774385
</div>
43784386

43794387
<div id="footer">
4380-
<div id="version">Wrye Bash v313</div>
4388+
<div id="version">Wrye Bash v314</div>
43814389
<a href="Wrye Bash General Readme.html">General</a>&#160;&#x2726;&#160;<a href="Wrye Bash Advanced Readme.html">Advanced</a>&#160;&#x2726;&#160;<a href="Wrye Bash Technical Readme.html">Technical</a>&#160;&#x2726;&#160;Versions
43824390
<div id="oldie">Javascript disabled, menu and slideshows nonfunctional.</div>
43834391
</div>

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
</figure>
5959
</div>
6060
<div id="footer">
61-
<div id="version">Wrye Bash v313</div>
61+
<div id="version">Wrye Bash v314</div>
6262
<a href="Wrye Bash General Readme.html">General</a>&#160;&#x2726;&#160;<a href="Wrye Bash Advanced Readme.html">Advanced</a>&#160;&#x2726;&#160;<a href="Wrye Bash Technical Readme.html">Technical</a>&#160;&#x2726;&#160;<a href="Wrye Bash Version History.html">Versions</a>
6363
<div id="oldie">Javascript disabled, menu and slideshows nonfunctional.</div>
6464
</div>

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
</figure>
6161
</div>
6262
<div id="footer">
63-
<div id="version">Wrye Bash v313</div>
63+
<div id="version">Wrye Bash v314</div>
6464
<a href="docs/Wrye Bash General Readme.html">General</a>&#160;&#x2726;&#160;<a href="docs/Wrye Bash Advanced Readme.html">Advanced</a>&#160;&#x2726;&#160;<a href="docs/Wrye Bash Technical Readme.html">Technical</a>&#160;&#x2726;&#160;<a href="docs/Wrye Bash Version History.html">Versions</a>
6565
<div id="oldie">Javascript disabled, menu and slideshows nonfunctional.</div>
6666
</div>

0 commit comments

Comments
 (0)