You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
These have pretty much been superseded by LOOT's capability to display
warnings and suggestions. Squashed version of these commits:
Removing RuleSets
Pass 1: Removing immediate references to RuleSets
Pass 2: Remove 'Show Notes', 'Show Config', and 'Show Suggest'
Remove RuleSets documentation
Update RuleSet removal for wx3 rewrite
Update RuleSet removal for inf-wx-begone
Co-authored-by: Infernio <infernio@icloud.com>
<li>Missing masters occur when a plugin that an active plugin depends on is not active. This results in an immediate CTD when the game is launched.
7093
7093
<li>Delinquent masters occur when a plugin's master loads after the plugin itself. This should be fixed to prevent issues in-game.
7094
7094
</ul>
7095
-
<p>The next section of the report details the output of any rulesets installed. These are text files that contain a set of instructions that tell the Mod Checker what to look for and what to say in the report if anything is found. Currently the only ruleset distributed by Wrye Bash is for Cobl. Rulesets are stored in <code>Data\Bash Patches</code> and end in <q>Rules.txt</q>. Information on ruleset syntax can be found in the <ahref="Wrye%20Bash%20Technical%20Readme.html#rulesets">Technical Readme</a>.
7096
-
<p>The rest of the report details any plugin groups that have been set up. Each group's section contains the following information:
7097
-
<ul>
7098
-
<li>Notes: These are various notes on the plugin group, as entered by the user.
7099
-
<li>Configuration: This is a summary of the plugin group's configuration. It uses a few symbols to denote the status of plugins, these are: x: active; +: merged; *: imported; -: inactive/unmerged.
7100
-
<li>Suggestions: Specific suggestions for the plugin group. These are typically activating or deactivating certain plugins, or replacing mods with other mods.
7101
-
<li>Warnings: Like suggestions, but the causes are more likely to cause issues. This section will detail what should be activated or deactivated to resolve the problems.
<tr><td>Forward/Back Arrows<td>The Mod Checker report may contain links to other pages. These two buttons allow navigation between pages viewed, similar to the forward/back buttons in a web browser.
7117
7109
<tr><td>Reload</td><td>Reloads the current page. Works identically to a browser's reload button.</td></tr>
7118
7110
<tr><td>Mod List<td>Toggles the display of the Active Mod Files list.
7119
-
<tr><td>Rule Sets<td>Toggles the display of the headers for the rulesets installed, even if they produce no other output.
7120
-
<tr><td>Notes<td>Toggles the display of plugin group notes.
7121
-
<tr><td>Configuration<td>Toggles the display of plugin groups' configurations.
7122
-
<tr><td>Suggestions<td>Toggles display of the suggestions produced by plugin groups.
7123
7111
<tr><td>Version Numbers<td>Toggles display of version numbers where found for the plugins in the Active Mod Files list.
7124
7112
<tr><td>CRCs<td>Toggles display of the CRCs for the plugins in the Active Mod Files list.
7125
7113
<tr><td>Scan for Dirty Edits<td>Toggles the scanning of plugins for dirty edits. Effectively runs <ahref="#modsScanForDirtyEdits">Scan for Dirty Edits</a> on each of the plugins in the Active Mod Files list and displays the results in the Mod Checker's report.
<p>This readme covers the most technical aspects of Wrye Bash, being the Wizard scripting language and the syntax used in Mod Checker rulesets. Information on the most commonly used aspects of Wrye Bash may be found in the <ahref="Wrye%20Bash%20General%20Readme.html">General Readme</a>, and the <ahref="Wrye%20Bash%20Advanced%20Readme.html">Advanced Readme</a> holds information on more advanced and less commonly used features. Wrye Bash's version history is stored in the <ahref="Wrye%20Bash%20Version%20History.html">Version History</a> document.
72
+
<p>This readme covers the most technical aspects of Wrye Bash, namely the Wizard scripting language and syntax for certain other file types. Information on the most commonly used aspects of Wrye Bash may be found in the <ahref="Wrye%20Bash%20General%20Readme.html">General Readme</a>, and the <ahref="Wrye%20Bash%20Advanced%20Readme.html">Advanced Readme</a> holds information on more advanced and less commonly used features. Wrye Bash's version history is stored in the <ahref="Wrye%20Bash%20Version%20History.html">Version History</a> document.
79
73
80
74
<h2id="darn">DarNified Books Wtxt Formatting</h2>
81
75
<p>The DarNified Books setting in the Bashed Patch's tweaks allows the use of Wtxt formatting, which is applied if the first line of a book is <code>== title ==</code>
@@ -1023,171 +1017,6 @@ <h4>Functions in OBMM that are meaningless in Wrye Bash</h4>
1023
1017
<tr><td><codeclass="box">AllowRunOnLines</code><td>Wizards support run-on lines as standard.
1024
1018
</table>
1025
1019
1026
-
<h2id="rulesets">Mod Checker Rulesets</h2>
1027
-
<h3id="rulesets-overview">Overview</h3>
1028
-
<p>Rulesets allow the expansion of Wrye Bash's Mod Checker to analyse active load orders based on additional rules. There can be any number of ruleset files, which must be plain text files located in <code><var>[Game]</var>\Data\Bash Patches</code>, with filenames ending in <code>Rules.txt</code>, for Wrye Bash to recognise them.
1029
-
<p>Rulesets are processed in alphabetical order of their filenames. A ruleset's output is given in the following order:
1030
-
<ol>
1031
-
<li>A header containing the ruleset name, and any supplied header text.
1032
-
<li>Warnings for any rules violated.
1033
-
<li>ModSet reports, in the order that they are defined in the ruleset. These consist of:
1034
-
<ol>
1035
-
<li>A configuration recap.
1036
-
<li>Any suggestions made.
1037
-
<li>Any include, exclude or merge only warnings generated.
1038
-
</ol>
1039
-
</ol>
1040
-
1041
-
<h3id="rulesets-syntax">Syntax</h3>
1042
-
<h4>Comments</h4>
1043
-
<p>Any text beginning with <code>##</code> will be ignored when the ruleset is processed, so can be used for making silent comments.
1044
-
<codeclass="box ruleset">xxx ## [comment]</code>
1045
-
<h4>Header</h4>
1046
-
<p>The header command can be used to define what text is displayed in the header of the ruleset's output.
1047
-
<codeclass="box ruleset">>> HEADER [text]
1048
-
1049
-
## A bulleted list:
1050
-
* [text]
1051
-
* [text]
1052
-
* [text]
1053
-
</code>
1054
-
<h4>NOTES</h4>
1055
-
<p>The <code>NOTES</code> command lets you output notes to the Mod Checker report. The possible formatting options are given in the formatting sub-section below. Notes can be multiline.
1056
-
<h4>ONLYONE</h4>
1057
-
<p>The <code>ONLYONE</code> command is a simple rule that states that only one of the rules following it may be active at any one time.
1058
-
<codeclass="box ruleset">>> ONLYONE
1059
-
Cobl Races.esp
1060
-
Cobl Races - Balanced.esp
1061
-
</code>
1062
-
<h4>IF</h4>
1063
-
<p>The <code>IF</code> command is used to specify that the <code>NOTES</code>, <code>CONFIG</code>, <code>SUGGEST</code> and <code>WARN</code> commands following it are conditional on the existence of the plugin(s) specified as part of the <code>IF</code> command. The effect of an <code>IF</code> command lasts until the next <code>IF</code> command or the end of the file, whichever comes first.
1064
-
<p>If the <code>IF</code> command lists more than one plugin, then the condition statement is a logical AND combination of all listed plugins. You can also specify logical OR and NOT combinations.
1065
-
<ul>
1066
-
<li><code>|</code>: This is the symbol for an OR combination of the previous plugin and the following plugin.
1067
-
<li><code>-</code>: This is the symbol for a NOT combination of the following plugin.
1068
-
</ul>
1069
-
<p>To specify that none of a set of plugins may exist, use a NOT for the first plugin of the set, then OR combine the it with the rest.
1070
-
<codeclass="box ruleset">>> IF Alpha.esp
1071
-
Beta.esp
1072
-
| Gamma.esp
1073
-
| Delta.esp
1074
-
- Epsilon.esp
1075
-
- Zeta.esp
1076
-
| Eta.esp
1077
-
Theta.esp
1078
-
</code>
1079
-
<p>The above equates to Alpha AND (Beta or Gamma or Delta) AND NOT(Epsilon) AND NOT(Zeta or Eta) AND Theta.</p>
1080
-
<h4>CONFIG</h4>
1081
-
<p>The <code>CONFIG</code> command lets you specify check the status of a plugin or plugins and output its/their status (active/inactive/merged) and a comment. It is intended as a way of reminding the user what plugins they have active.
1082
-
<codeclass="box ruleset">>> CONFIG
1083
-
o Plugin1.esp //[comment]
1084
-
o Plugin2.esp //[comment]
1085
-
</code>
1086
-
<p>The <code>o</code> symbol denotes an <q>Option</q> rule type.
1087
-
<h4>SUGGEST</h4>
1088
-
<p>The <code>SUGGEST</code> command is intended as a way of providing non-critical suggestions. Its syntax is similar to that of the <code>CONFIG</code> command, but it has different rule types available for usage. The rule types are:
1089
-
<ul>
1090
-
<li><code>x</code>: <q>Inclusion</q> rule type. The specified plugin must be active. If the plugin is not active, the Mod Checker will output a message.
1091
-
<li><code>-</code>: <q>Exclusion</q> rule type. The specified plugin must <strong>not</strong> be active. If the plugin is active, the Mod Checker will output a message.
1092
-
<li><code>+</code>: <q>Merge Only</q> rule type. The specified plugin must be merged but <strong>not</strong> active. If the plugin is active or inactive and not merged, the Mod Checker will output a message.
1093
-
<li><code>e</code>: <q>Existence</q> rule type. The specified file must exist. The file can be any file type, with the file path being given relative to the Data folder. If the file does not exist, the Mod Checker will output a message.
1094
-
</ul>
1095
-
<codeclass="box ruleset">>> SUGGEST
1096
-
x Plugin1.esp //[comment]
1097
-
- Plugin2.esp //[comment]
1098
-
+ Plugin3.esp //[comment]
1099
-
e Plugin4.esp //[comment]
1100
-
</code>
1101
-
<h4>WARN</h4>
1102
-
<p>The <code>WARN</code> command is intended as a way of providing critical suggestions. It shares the same rule types as the <code>SUGGEST</code> command.
1103
-
<codeclass="box ruleset">>> WARN
1104
-
x Plugin1.esp //[comment]
1105
-
- Plugin2.esp //[comment]
1106
-
+ Plugin3.esp //[comment]
1107
-
e Plugin4.esp //[comment]
1108
-
</code>
1109
-
<h4>ASSUME</h4>
1110
-
<p>The <code>ASSUME</code> command inserts the assumption that the given plugin exists into any <code>IF</code> statements following the command.
1111
-
<ul>
1112
-
<li><code>ASSUME</code> commands last until the next <code>ASSUME</code> command or until the end of the file, whichever occurs first.
1113
-
<li><code>ASSUME</code> commands are <strong>not</strong> additive: each <code>ASSUME</code> command completely replaces the previous one.
1114
-
<li>To cancel the effect of an <code>ASSUME</code> command, use an <code>ASSUME</code> command with no mod listed for it.
1115
-
<li>To assume the existence of multiple plugins, list them on separate lines after the <code>ASSUME</code> command, like how is done for the <code>IF</code> command.
- Beer! for Oblivion.esp [1.2.3:]-- **Deactivate.** Included in Cobl Main.esm.
1161
-
- DaggerfallBooks.esp // **Deactivate.** Included in Cobl Main.esm.
1162
-
- FirstEditionGuidetotheEmpire.esp // **Deactivate.** Included in Cobl Main.esm.
1163
-
- Ingredient Storage Shelves.esp // **Deactivate.** Included in Cobl Glue.esp
1164
-
- MorrowindBooks.esp // **Deactivate.** Included in Cobl Main.esm.
1165
-
- Salmo the Baker v2.0.esp // **Deactivate** Use Salmo the Baker, Cobl instead.
1166
-
- Tamrielic_Ingredients.esm // **Deactivate.** Included in Cobl Main.esm.
1167
-
- Tamrielic_Ingredients.esp // **Deactivate.** Included in Cobl Main.esm.
1168
-
1169
-
>> ASSUME Cobl Main.esm
1170
-
1171
-
>> IF Cobl Races.esp
1172
-
>> WARN
1173
-
e meshes\characters\saram\femalehair\type0\01.nif // __Missing meshes [Saram].__ Be sure that you have installed [[https://www.nexusmods.com/oblivion/mods/21104|Cobl Cosmetics Res 01]].
1174
-
e meshes\clothes\asxivilai\xivilaicollar.nif // __Missing meshes [xivilai].__ Be sure that you have installed [[https://www.nexusmods.com/oblivion/mods/21104|Cobl Cosmetics Res 01]].
1175
-
x DLCShiveringIsles.esp // **Activate** Required (meshes and textures).
1176
-
1177
-
>> IF Cobl Races - Balanced.esp
1178
-
>> WARN
1179
-
x Cobl Races.esp // **Activate.** Required.
1180
-
1181
-
>> IF Cobl Si.esp
1182
-
>> WARN
1183
-
x DLCShiveringIsles.esp // **Activate.** Required.
0 commit comments