Skip to content

Commit

Permalink
Regenerate history for 306/305/304.4
Browse files Browse the repository at this point in the history
We lose four manual notes, but there was nothing all that important in
those anyways. Makes the docs nice and uniform after the switch to git.
Plus of course the links to issues are 100x more useful than any text
you could type there.

Mopy/Docs/Wrye Bash Advanced Readme.html:
Readme.md:
Some edits for clarification in the Python Components section of the
readme, bumping the py2 version, and dropping the stupidly complicated
instructions for scandir (just use pip install -r requirements.txt).
  • Loading branch information
Infernio committed Sep 16, 2020
1 parent 15c02e0 commit e0287b1
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 96 deletions.
34 changes: 8 additions & 26 deletions Mopy/Docs/Wrye Bash Advanced Readme.html
Expand Up @@ -186,36 +186,18 @@ <h3 id="install-alternate">Alternative Install Locations <a class="back2top" hre


<h3 id="install-components">Python Components <a class="back2top" href="#contents">Back to top</a></h3>
<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 class="emphasis">Note that the 32-bit versions are required even if you are on a 64-bit operating system.
<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>
<p>Installation is easiest by just using pip, which comes with Python (see below). Simply run <code>path/to/python.exe -m pip install -r requirements.txt</code>
(obviously replacing <code>path/to/python.exe</code> with the actual path to your python.exe).</p>
<p class="emphasis">Note that the 32-bit versions are required even if you are on a 64-bit operating system.</p>
<ul>
<li><a href="https://www.python.org/ftp/python/2.7.16/python-2.7.16.msi">Python 2.7.16</a>: Versions prior to 2.7.16 may work with Wrye Bash, but have not been tested. Updating is recommended for bug and security fixes.
<li><a href="https://pypi.org/project/wxPython">wxPython 4.0.7.post2 for Python 2.7</a>: Newer versions may work, older ones will not</li>
<li><a href="https://www.python.org/ftp/python/2.7.18/python-2.7.18.msi">Python 2.7.18</a>: Versions prior to 2.7.18 may work with Wrye Bash, but have not been tested. Updating is recommended for bug and security fixes.
<li><a href="https://pypi.org/project/wxPython">wxPython 4.0.7.post2</a>: Newer versions may work, older ones will not</li>
<li><a href="https://pypi.org/project/chardet/">Mozilla's chardet library</a>: Wrye Bash uses this library to help in detecting
character encodings used when reading and writing encoded Unicode strings.
<li><a href="https://sourceforge.net/projects/pywin32/files/pywin32/Build%20220/pywin32-220.win32-py2.7.exe/download">PyWin32</a>: This component is required for Wizards to function. If you do not wish to use Wizards, then it need not be installed.
<li><a href="https://pypi.python.org/pypi/pywin32">PyWin32</a>: This component is required for Wizards to function. If you do not wish to use Wizards, then it need not be installed.
<li><a href="https://pypi.python.org/pypi/scandir">scandir</a>: Optional but highly recommended module (in the standard library since
python 3.5). Scandir speeds up disk I/O operations (namely os. walk) by 5-50x on the Windows operating system family. There are several
ways to install Scandir, in levels of increasing complexity
<ul>
<li>The first is to download the Scandir wheel file (.whl)&nbsp; and install it using the Pip command line tool.</li>
<ul>
<li>Browse to the <a href="https://pypi.python.org/pypi/scandir" target="_blank">official Python Scandir page</a> and download <a href="https://files.pythonhosted.org/packages/9e/a5/56b4dec02b16bb720cac9872fccd63b61a815b70633ef15bfe3ea5ce4488/scandir-1.9.0-cp27-cp27m-win32.whl" target="_blank">scandir-1.9.0-cp27-cp27m-win32.whl</a> or newer. Remember the path to the download location on your hard disk.&nbsp; For this example we will use "C:\Downloads\".
<li>Open a Windows command or Powershell prompt and issue the <code>command python.exe -m pip install C:\Downloads\scandir-1.9.0-cp27-cp27m-win32.whl</code></li>
<li>Follow the instructions on screen if any appear.
</ul>
<li>The second method is to install Scandir via the Python pip package manager.
</li>
<ul>
<li>Open a Windows command prompt or Powershell prompt.
<li>Issue the command <code>python.exe -m pip install --upgrade scandir</code>
<ul>
<li>You may be asked to install the 'Microsoft Visual C++ Compiler for Python 2.7'. In this event, download and install the compiler from the <a href="https://www.microsoft.com/en-us/download/details.aspx?id=44266" target="_blank">official Microsoft download page</a>.
<li>You may also be asked to install Python "setuptools". To install setuptools, issue the command (from within the same command prompt is fine) <code>python.exe -m pip install --upgrade setuptools</code>
<li>Once these two tools are installed the installation should proceed as expected.
</ul>
</ul>
</ul>
python 3.5). Scandir speeds up disk I/O operations (namely os. walk) by 5-50x on the Windows operating system family.</li>
</ul>

<h2 id="bain">Installers Tab <a class="back2top" href="#contents">Back to top</a></h2>
Expand Down
128 changes: 62 additions & 66 deletions Mopy/Docs/Wrye Bash Version History.html
Expand Up @@ -162,80 +162,76 @@ <h3>307 Refactoring, new features &amp; games [2020/09/16] [Various community me

<h3>306 Code refactoring, performance [2015/11/07] [Utumno]</h3>
<ul>
<li>Option to list dependencies on a particular mod [Utumno]</li>
<li>Optionally skip instead of ignoring Skyrim .BSL [Utumno]</li>
<li>Wine Compatibility [Utumno]</li>
<li>Oblivion esm version swapping fixups [Utumno]</li>
<li>Switching save profile does not activate mods for this save profile [Utumno]</li>
<li>Master list fixups and enhancements [Utumno]</li>
<li>UnicodeDecodeError on tmp dir creation when username contains non ascii chars [Utumno]</li>
<li>Table.dat fixups [Utumno]</li>
<li>Scroll position not set on startup (Installers, People and Screens tabs) [Utumno]</li>
<li>Delete fixups [Utumno]</li>
<li>Ghosted Plugins Sorted after the Bash Patch [Utumno]</li>
<li>Bash loads an invalid plugins.txt without notifying the user of the error. [Utumno]</li>
<li>Mergeable plugins do not auto deactivate [Utumno]</li>
<li>Error when applying BCF [Utumno]</li>
<li>[Ini setting] re-add setting for BOSS executable location [Sharlikran]</li>
<li>[Ini setting] Disable prompt for activating bashed patch [Utumno]</li>
<li>skyrim_const.py is missing the 3rd hi-res DLC file in bethDataFiles array [jfpelland]</li>
<li>Added a force UTF-8 option to plugin encodings. [Utumno]</li>
<li>Skyrim - New GMST settings tweaks requests [jfpelland]</li>
<li>Huge lag when switching back to mods tab from another application [Utumno]</li>
<li>Menu item to load only selected mods [Utumno]</li>
<li>Comments box forgets its size [Utumno]</li>
<li>UnicodeDecodeError when importing a face to a save [Utumno]</li>
<li>Rework Mod Groups - remove BALO [Utumno]</li>
<li>Bash should send deleted files to the Recycle Bin [Utumno]</li>
<li>Masters list displays incorrectly [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/227">#227</a>: Option to list dependencies on a particular mod [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/217">#217</a>: Optionally skip instead of ignoring Skyrim .BSL [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/203">#203</a>: Wine Compatibility [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/198">#198</a>: Oblivion esm version swapping fixups [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/195">#195</a>: Switching save profile does not activate mods for this save profile [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/192">#192</a>: Master list fixups and enhancements [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/180">#180</a>: UnicodeDecodeError on tmp dir creation when username contains non ascii chars [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/176">#176</a>: Table.dat fixups [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/175">#175</a>: Scroll position not set on startup (Installers, People and Screens tabs) [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/172">#172</a>: Delete fixups [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/164">#164</a>: Ghosted Plugins Sorted after the Bash Patch [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/162">#162</a>: Bash loads an invalid plugins.txt without notifying the user of the error. [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/157">#157</a>: Mergeable plugins do not auto deactivate [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/155">#155</a>: Error when applying BCF [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/154">#154</a>: bash.ini : add setting for BOSS executable location [Sharlikran]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/149">#149</a>: [Ini setting] Disable prompt for activating bashed patch [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/144">#144</a>: Split game names into filesystem and display strings [Ortham]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/143">#143</a>: skyrim_const.py is missing the 3rd hi-res DLC file in bethDataFiles array [jfpelland]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/142">#142</a>: Added a force UTF-8 option to plugin encodings. [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/141">#141</a>: Skyrim - New GMST settings tweaks requests [jfpelland]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/123">#123</a>: Huge lag when switching back to mods tab from another application [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/109">#109</a>: Menu item to load only selected mods [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/94">#94</a>: Comments box forgets its size [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/85">#85</a>: UnicodeDecodeError when importing a face to a save [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/82">#82</a>: Tags point to the old rebased commits [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/35">#35</a>: Rework Mod Groups - remove BALO [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/32">#32</a>: Bash should send deleted files to the Recycle Bin [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/27">#27</a>: Masters list displays incorrectly [Utumno]</li>
</ul>

<h3>305 Bug fixes and enhancements [2014/08/23] [Various community members]</h3>
<ul>
<li>Due to the change from the BOSS API to the LOOT API, and due to internal changes in the way the Standalone is created, <strong>no</strong> MSVC redistributables are required for either Python or Standalone Wrye Bash.</li>
<li>Corrected the "Cannot load plugins before masters" error that many users were experiencing. [WrinklyNinja]</li>
<li>Corrected the "'int' object has no attribute 'startswith'" error that often happened when using the Race Patcher. [jfpelland]</li>
<li>The Standalone no longer reads loose Python files. This was originally a method to allow small updates, however it ends up causing problems if you have Python files from an older Wrye Bash along side a newer Stadnalone. [lojack5]</li>
<li>Corrected an error when adding a shortcut to a batch script to the Apps folder. [jfpelland]</li>
<li>Corrected errors with the DocBrowser when the set document file was missing. [lojack5]</li>
<li>Corrected BAIN Regression: BAIN was not uninstalling all files. This was affecting both uninstalling and annealling. [lojack5]</li>
<li>Corrected a few rare Wizard exceptions. [lojack5]</li>
<li>Corrected an error for some users with Backup Bash Settings. [jfpelland]</li>
<li>Corrected an error in the Installers Tab after deleting a Save Game. [lojack5]</li>
<li>Corrected an issue that caused the Bashed Patch Tweak Settings to be non-persistent. [lojack5]</li>
<li>Fixed "Copy Conflicts to Project" [Utumno]</li>
<li>Includes bluesky404's updates for Chinese Traditional and Simplified. [bluesky404/Sharlikran]</li>
<li>Various Readme Updates. [Sharlikran]</li>
<li>Updated taglist.yaml files (bundled Bash Tags list). [Sharlikran]</li>
<li>Updated Oblivion record definitions. [Shalikran]</li>
<li>BOSS launcher fixes. [WrinklyNinja]</li>
<li>Updated SplashScreen so it no longer has a version number. [Sharlikran]</li>
<li>Replaced BOSS API with LOOT API. [WrinklyNinja]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/140">#140</a>: Standalone reading loose Python files [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/138">#138</a>: bluesky404&#x27;s updates for Chinese Traditional and Simplified [Sharlikran]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/135">#135</a>: Error when adding a shortcut to a batch script to the Apps folder [jfpelland]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/134">#134</a>: Readme Updates [Sharlikran]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/133">#133</a>: DocBrowser errors when the set doc file is missing [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/132">#132</a>: Updated taglist.yaml files [Sharlikran]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/131">#131</a>: Updates to oblivion.py [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/130">#130</a>: Regression: BAIN does not uninstall all files [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/128">#128</a>: BOSS launcher fixes [Ortham]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/126">#126</a>: Wizard exceptions [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/119">#119</a>: Backup Bash Settings causes exception [jfpelland]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/118">#118</a>: Updated SplashScreen so it no longer has a version number. [Sharlikran]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/117">#117</a>: Regression: can&#x27;t install/uninstall rar files in 305 dev build [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/115">#115</a>: Error in Installers Tab after deleting a Save Game [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/114">#114</a>: Bashed Patch Tweak Settings options are not persistent. [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/112">#112</a>: Replaced BOSS API with LOOT API [Ortham]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/111">#111</a>: Cannot load plugins before masters [Ortham]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/107">#107</a>: Installer Handling of MSVC Redistributables [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/105">#105</a>: Copy Conflicts to Project not working [Utumno]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/103">#103</a>: Build script improvements [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/95">#95</a>: &#x27;int&#x27; object has no attribute &#x27;startswith&#x27; [jfpelland]</li>
</ul>

<h3>304.4 Move to git [2014/07/06] [Various community members]</h3>
<ul>
<li>Moved to GitHub from Sourceforge: <a href="https://github.com/wrye-bash">https://github.com/wrye-bash</a>. [Lojack, Utumno, Wrinklyninja]
<li>Make splash screen optional [lojack5]</li>
<li>Installers.bat is not backed up when prompting user to backup settings on version change [lojack5]</li>
<li>Mods Tab: Load -&gt; All throws an exception [lojack5]</li>
<li>sort order reverses [lojack5]</li>
<li>shellMakeDirs may fall into an infinite loop [lojack5]</li>
<li>Fixed error when copying files from an archive in BAIN. [bluesky404]
<li>Fixed load order changes outside of Bash not being detected. [wrinklyninja]
<li>Fixed unnecessary timestamp changes when setting load order. [wrinklyninja]
<li>Updated BOSS API to v3.0.0. [wrinklyninja]
<li>Implemented support for launching BOSS v3.0.0. [wrinklyninja]
<li>Documentation updates. [wrinklyninja]
<li>Streamlined installer's handling of requirements. [wrinklyninja]
<li>Optimize PNGs [Metallicow]</li>
<li>Remove the auto-updater [lojack5]</li>
<li>Skip .bsl files for BAIN [lojack5]</li>
<li>BOSSv3 support, installer and readme updates [WrinklyNinja]</li>
<li>Installer Improvements [WrinklyNinja]</li>
<li>Installer MSVC 2013 Redist Support [WrinklyNinja]</li>
<li>Missing context menu items [WrinklyNinja]</li>
<li>Show BSA Conflicts undocumented [WrinklyNinja]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/99">#99</a>: Make splash screen optional [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/98">#98</a>: Installers.bat is not backed up when prompting user to backup settings on version change [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/91">#91</a>: Mods Tab: Load -&gt; All throws an exception [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/90">#90</a>: sort order reverses [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/87">#87</a>: shellMakeDirs may fall into an infinite loop [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/61">#61</a>: Optimize PNGs [Metallicow]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/57">#57</a>: Remove the auto-updater [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/28">#28</a>: Skip .bsl files for BAIN [lojack5]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/22">#22</a>: BOSSv3 support, installer and readme updates [Ortham]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/17">#17</a>: Installer Improvements [Ortham]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/16">#16</a>: Installer MSVC 2013 Redist Support [Ortham]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/14">#14</a>: Missing context menu items [Ortham]</li>
<li><a href="https://github.com/wrye-bash/wrye-bash/issues/13">#13</a>: Show BSA Conflicts undocumented [Ortham]</li>
</ul>

<h3>304.3 Beta [2013/11/21] [Various community members]</h3>
Expand Down
8 changes: 4 additions & 4 deletions Readme.md
Expand Up @@ -69,10 +69,10 @@ path/to/python.exe -m pip install -r requirements.txt
Refer to the readmes for [detailed instructions][12]. In short:

1. Install one of the supported games (Oblivion, Skyrim, Fallout).
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.
1. Install Python and plugins above.
1. Extract the downloaded Wrye Bash archive into your game folder.
1. Run Wrye Bash by double-clicking "Wrye Bash Launcher.pyw" in the new Mopy
folder.

#### WINE

Expand Down

0 comments on commit e0287b1

Please sign in to comment.