Skip to content

Commit 893ad96

Browse files
SharlikranInfernio
authored andcommitted
Slightly restructure Installer menu
Originally by Sharlikran, reworked it slightly so that all the install options are inside the 'Install..' submenu and moved the 'List Structure...' command back into 'Package..' - it doesn't make any sense in the Install submenu, so Package is a better fit. Also moved 'Refresh' back into the package submenu, since it's so rarely needed - we don't want to confuse new users by putting those two right next to each other. Also added matching readme edits and redid affected screenshots. Co-authored-by: Infernio <infernio@icloud.com>
1 parent 32c72f2 commit 893ad96

11 files changed

Lines changed: 105 additions & 95 deletions

Mopy/Docs/Wrye Bash Advanced Readme.html

Lines changed: 57 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -615,28 +615,27 @@ <h3 id="bain-commands">Context Menu Commands <a class="back2top" href="#contents
615615
</table>
616616
</div>
617617
<div class="prlflex clearf">
618-
<figure class="slideshow" style="width:459px; min-height:445px">
618+
<figure class="slideshow" style="width:555px; min-height:386px">
619619
<img alt="Installer Context Menu" src="../bash/images/readme/installers-rclick-installer-menu-1.png">
620620
<img alt="Installer Context Menu" src="../bash/images/readme/installers-rclick-installer-menu-2.png">
621621
<img alt="Installer Context Menu" src="../bash/images/readme/installers-rclick-installer-menu-3.png">
622622
<img alt="Installer Context Menu" src="../bash/images/readme/installers-rclick-installer-menu-4.png">
623623
<img alt="Installer Context Menu" src="../bash/images/readme/installers-rclick-installer-menu-5.png">
624624
<img alt="Installer Context Menu" src="../bash/images/readme/installers-rclick-installer-menu-6.png">
625-
<img alt="Installer Context Menu" src="../bash/images/readme/installers-rclick-installer-menu-7.png">
626625
</figure>
627626
<table id="bainPackageCommands">
628627
<thead>
629628
<tr>
630-
<th colspan="3">Package Context Menu</th>
629+
<th colspan="4">Package Context Menu</th>
631630
</tr>
632631
<tr>
633-
<th colspan="2">Command</th>
632+
<th colspan="3">Command</th>
634633
<th>Description</th>
635634
</tr>
636635
</thead>
637636
<tbody>
638637
<tr>
639-
<td rowspan="6" id="bainFileMenu">File...</td>
638+
<td colspan="2" rowspan="6" id="bainFileMenu">File...</td>
640639
<td id="bainOpenFile">Open...</td>
641640
<td>Opens the selected package(s) in the file system.</td>
642641
</tr>
@@ -664,7 +663,7 @@ <h3 id="bain-commands">Context Menu Commands <a class="back2top" href="#contents
664663
<strong>not</strong> sent to the Recycling Bin, they are permanently deleted.</td>
665664
</tr>
666665
<tr>
667-
<td rowspan="4" id="bainOpenAt">Open at</td>
666+
<td colspan="2" rowspan="4" id="bainOpenAt">Open at</td>
668667
<td>Google...</td>
669668
<td>Attempts to perform a Google search for the selected package's name.</td>
670669
</tr>
@@ -681,38 +680,17 @@ <h3 id="bain-commands">Context Menu Commands <a class="back2top" href="#contents
681680
<td>Attempts to open the selected package's page on TES Alliance. This command assumes that the trailing digits in a package's name is the package ID at the site.</td>
682681
</tr>
683682
<tr>
684-
<td colspan="2" id="bainAnneal">Anneal</td>
683+
<td colspan="3" id="bainOpenReadme">Open Readme</td>
684+
<td>If BAIN detects a readme in the selected package, it will be opened.</td>
685+
</tr>
686+
<tr>
687+
<td colspan="3" id="bainAnneal">Anneal</td>
685688
<td>Installs missing files and corrects install order errors. Note: If an already installed file is changed outside of Wrye Bash control, Wrye Bash will not anneal that file. Anneal is relative to other installed packages. This is because we do not want to override user changes like cleaning plugins and the like. If you do want to override the change use
686689
<a href="#bainInstall">Install</a> instead. Note2: The change will be detected immediately in case of ini tweaks, mods or bsas, but on next Bash load for other files (like nifs etc). To detect the change without restarting
687690
<a href="#bainQuickRefresh">(Quick) Refresh</a> the package.</td>
688691
</tr>
689692
<tr>
690-
<td colspan="2" id="bainInstall">Install</td>
691-
<td>Fully installs the package except for files that would be overridden by later packages.</td>
692-
</tr>
693-
<tr>
694-
<td rowspan="3" id="bainWizardMenu">Wizard Installer...</td>
695-
<td id="bainWizard">Manual Wizard</td>
696-
<td>Runs the Wizard for the package, if it has one.</td>
697-
</tr>
698-
<tr>
699-
<td id="bainAutoWizard">Auto Wizard</td>
700-
<td>Runs the Wizard for the package, if it has one, selecting the default options.</td>
701-
</tr>
702-
<tr>
703-
<td id="bainViewWizard">View Wizard...</td>
704-
<td>Opens the wizard.txt for viewing.</td>
705-
</tr>
706-
<tr>
707-
<td colspan="2" id="bainInstallMissing">Install Missing Files</td>
708-
<td>The same as Install, except that it only installs missing files – i.e. it will not override any currently existing files.</td>
709-
</tr>
710-
<tr>
711-
<td colspan="2" id="bainUninstall">Uninstall</td>
712-
<td>Uninstalls the package. If Auto-Anneal is active (the default) then files from earlier packages that were previously overridden will be installed as required.</td>
713-
</tr>
714-
<tr>
715-
<td colspan="2" id="bainQuickRefresh">Quick Refresh</td>
693+
<td colspan="3" id="bainQuickRefresh">Quick Refresh</td>
716694
<td>
717695
<p>Refreshes all info for the selected package(s), also checking the files that correspond to this package inside the Data directory. It will bypass skip refresh flags on projects (see case A below). BAIN does refresh package information whenever the installer's tab regains focus, except for projects if project skipping is on, but does not scan the Data folder but once on boot.</p> So this command is useful if:
718696
<ol type="A">
@@ -727,20 +705,45 @@ <h3 id="bain-commands">Context Menu Commands <a class="back2top" href="#contents
727705
</td>
728706
</tr>
729707
<tr>
730-
<td colspan="2" id="bainExportACHlist">Export ACHList</td>
731-
<td> This exports a file list of the files configured to be installed by this installer (except top level files and docs installed in Data/Docs folder). This list is used when the CK asks for a list of files to make new BSA files, for use when uploading to Bethesda.net. It will generate a
732-
<code>installer-name.achlist</code> file inside the Mod Info Exports directory in the game (exe) folder. Mod Info Exports will be created if it doesn't exist. If an achlist with the same name exists it will be overwritten. Import the ACHList Bash generated and it will then package your files into the proper archives for upload. Available only for Skyrim&colon; Special Edition &amp; Fallout 4. </td>
708+
<td colspan="3" id="bainMoveTo">Move To...</td>
709+
<td>Moves the selected package(s) to the specified position.</td>
733710
</tr>
734711
<tr>
735-
<td rowspan="10" id="bainPackageMenu">Package..</td>
736-
<td id="bainOpenReadme">Open Readme</td>
737-
<td>If BAIN detects a readme in the selected package, it will be opened.</td>
712+
<td rowspan="7">Install..</td>
713+
<td colspan="2" id="bainInstall">Install</td>
714+
<td>Fully installs the package except for files that would be overridden by later packages.</td>
738715
</tr>
739716
<tr>
740-
<td id="bainMoveTo">Move To...</td>
741-
<td>Moves the selected package(s) to the specified position.</td>
717+
<td colspan="2" id="bainInstallMissing">Install Missing Files</td>
718+
<td>The same as Install, except that it only installs missing files – i.e. it will not override any currently existing files.</td>
719+
</tr>
720+
<tr>
721+
<td colspan="2" id="bainInstallLast">Install Last</td>
722+
<td>Moves the package to the end of the order list and installs it.</td>
723+
</tr>
724+
<tr>
725+
<td rowspan="4" id="bainWizardMenu">Wizard Installer...</td>
726+
<td id="bainWizard">Manual Wizard...</td>
727+
<td>Runs the Wizard for the package, if it has one.</td>
728+
</tr>
729+
<tr>
730+
<td>Auto Wizard...</td>
731+
<td>Runs the Wizard for the package, if it has one, selecting the default options.</td>
732+
</tr>
733+
<tr>
734+
<td>View Wizard...</td>
735+
<td>Archives Only. Opens the wizard.txt for viewing.</td>
736+
</tr>
737+
<tr>
738+
<td>Edit Wizard...</td>
739+
<td>Projects Only. Opens the wizard.txt in your system's default <code>.txt</code> editor.</td>
742740
</tr>
743741
<tr>
742+
<td colspan="3" id="bainUninstall">Uninstall</td>
743+
<td>Uninstalls the package. If Auto-Anneal is active (the default) then files from earlier packages that were previously overridden will be installed as required.</td>
744+
</tr>
745+
<tr>
746+
<td colspan="2" rowspan="8" id="bainPackageMenu">Package..</td>
744747
<td id="bainRefresh">Refresh</td>
745748
<td>As
746749
<a href="#bainRefresh">Quick Refresh</a> below. Refresh will however recalculate the
@@ -753,8 +756,9 @@ <h3 id="bain-commands">Context Menu Commands <a class="back2top" href="#contents
753756
<strong>and</strong> its size</em> - that's super rare, you most probably just need Quick Refresh below.</td>
754757
</tr>
755758
<tr>
756-
<td id="bainListStructure">List Structure...</td>
757-
<td>Generates a list of the files and directories in a package. Useful for posting package structure on forums, eg. when troubleshooting an install.</td>
759+
<td id="bainExportACHlist">Export Achlist</td>
760+
<td> This exports a file list of the files configured to be installed by this installer (except top level files and docs installed in Data/Docs folder). This list is used when the CK asks for a list of files to make new BSA files, for use when uploading to Bethesda.net. It will generate a
761+
<code>installer-name.achlist</code> file inside the Mod Info Exports directory in the game (exe) folder. Mod Info Exports will be created if it doesn't exist. If an achlist with the same name exists it will be overwritten. Import the ACHList Bash generated and it will then package your files into the proper archives for upload. Available only for Skyrim&colon; Special Edition &amp; Fallout 4. </td>
758762
</tr>
759763
<tr>
760764
<td id="bainPackToArchive">Pack to Archive...</td>
@@ -764,6 +768,10 @@ <h3 id="bain-commands">Context Menu Commands <a class="back2top" href="#contents
764768
<td id="bainPackageForRelease">Package For Release...</td>
765769
<td>Projects only. Just like "Pack to Archive" except it doesn't archive the following: thumbs.db, desktop.ini, and any folder that begins with "--".</td>
766770
</tr>
771+
<tr>
772+
<td id="bainListStructure">List Structure...</td>
773+
<td>Generates a list of the files and directories in a package. Useful for posting package structure on forums, eg. when troubleshooting an install.</td>
774+
</tr>
767775
<tr>
768776
<td id="bainSyncFromData">Sync From Data</td>
769777
<td>Projects only. Synchronize the project with files from the Data directory. This is essentially the reverse of "Install" for projects since it copies from the Data directory to the project rather than the other way around.</td>
@@ -779,11 +787,7 @@ <h3 id="bain-commands">Context Menu Commands <a class="back2top" href="#contents
779787
<a href="#bainShowLowerConflicts">Show Lower Conflicts</a> options were selected. Useful for comparing conflicting resources.</td>
780788
</tr>
781789
<tr>
782-
<td id="bainInstallLast">Install Last</td>
783-
<td>Moves the package to the end of the order list and installs it.</td>
784-
</tr>
785-
<tr>
786-
<td rowspan="2" id="bainConversion">BAIN Conversions</td>
790+
<td colspan="2" rowspan="2" id="bainConversion">BAIN Conversions</td>
787791
<td>Create...</td>
788792
<td>Archives only. Creates a new Bain Conversion File.</td>
789793
</tr>
@@ -792,31 +796,31 @@ <h3 id="bain-commands">Context Menu Commands <a class="back2top" href="#contents
792796
<td>[BCF] is the name of a Bain Conversion File listed in the Apply submenu. Selecting a BCF applies it to the selected package.</td>
793797
</tr>
794798
<tr>
795-
<td colspan="2" id="bainHasExtraDirectories">Has Extra Directories</td>
799+
<td colspan="3" id="bainHasExtraDirectories">Has Extra Directories</td>
796800
<td>BAIN only recognises a limited set of subdirectories of the Data folder (the
797801
<a href="Wrye%20Bash%20General%20Readme.html#bain-structure">standard game directories</a>), and skips any unrecognised subdirectories. Checking this option will cause BAIN to install unrecognised subdirectories (Unless the files within are on the list of files which are always skipped such as .exe files, see
798802
<a href="#bain-skipped">Skipped Files</a>)
799803
<br>
800804
<strong>NB:</strong> extra directories will not be taken into account at all when calculating package structure. There must be at least some standard game directory or a data file (plugin, bsa/ba2, ini) in the package for BAIN to recognise its structure.</td>
801805
</tr>
802806
<tr>
803-
<td colspan="2" id="bainOverrideSkips">Override Skips</td>
807+
<td colspan="3" id="bainOverrideSkips">Override Skips</td>
804808
<td>If this is checked, Bain will not skip over files that would normally be skipped due to a
805809
<a href="#bainGlobalSkips">global skip option</a>.</td>
806810
</tr>
807811
<tr>
808-
<td colspan="2" id="bainSkipVoices">Skip Voices</td>
812+
<td colspan="3" id="bainSkipVoices">Skip Voices</td>
809813
<td>If this is checked, Bain will skip over any voice files in the package. This is useful if the voice files are empty and/or the user prefers not to use them. If this option is used, then the user should also use Elys'
810814
<a href="https://www.nexusmods.com/oblivion/mods/16622">Universal Silent Voice</a> extension to prevent dialog subtitles from fading too rapidly.</td>
811815
</tr>
812816
<tr>
813-
<td colspan="2" id="bainDontRefresh">Don't Refresh</td>
817+
<td colspan="3" id="bainDontRefresh">Don't Refresh</td>
814818
<td>When refreshing installers (when switching out and in the installers tab), this
815819
<em>project</em> won't be scanned for changes. The project will only get refreshed during the first refresh of BAIN on a restart, or by manually refreshing (see
816820
<a href="#bainQuickRefresh">Quick Refresh</a> and co)</td>
817821
</tr>
818822
<tr>
819-
<td colspan="2" id="bainOmodInfo">Omod Info...</td>
823+
<td colspan="3" id="bainOmodInfo">Omod Info...</td>
820824
<td>Projects only. Allows you to read/write omod configuration info.</td>
821825
</tr>
822826
</tbody>

0 commit comments

Comments
 (0)