Tweak cleaning data metadata structure

Rename `util` to `utility`, and add an `info` key that acts like the
message structure's `content` key. Also change the generated message
structures slightly to reflect the changes. Closes #608.
This commit is contained in:
Oliver Hamlet
2016-08-06 16:58:42 +01:00
parent bdd1cabb72
commit 01836966b4
19 changed files with 349 additions and 232 deletions
+2 -1
View File
@@ -433,7 +433,8 @@ name: 'Unofficial Skyrim Patch on Steam Workshop'
<thead><tr><th>Key Name<th>Value Type<th>Required<th>Notes
<tbody>
<tr><td><code>crc</code><td>hexadecimal integer<td>&#x2713;<td>The CRC-32 checksum of the plugin. If the plugin is dirty, this needs to be the CRC of the plugin before before cleaning. LOOT displays the CRCs of installed plugins in its report. The 8-character CRC should be preceded by <code>0x</code> so that it is correctly interpreted.
<tr><td><code>util</code><td>string<td>&#x2713;<td>The utility that should be or that was used to clean the plugin.
<tr><td><code>utility</code><td>string<td>&#x2713;<td>The utility that was used to check the plugin for dirty edits. If available, the version of the utility used should also be included (e.g. <code>TES5Edit v3.11</code>).
<tr><td><code>info</code><td>string <em>or</em> localised content list<td>&#x2717;<td>A message that will be displayed to the user. If a localised content list is provided, one of the structures must be for English. This is only used if the plugin is dirty, and is intended for providing cleaning instructions to the user.
<tr><td><code>itm</code><td>integer<td>&#x2717;<td>The number of identical-to-master records reported for the dirty plugin. If the number is unknown or zero, this field should not be supplied.
<tr><td><code>udr</code><td>integer<td>&#x2717;<td>The number of undeleted records reported for the dirty plugin. If the number is unknown or zero, this field should not be supplied.
<tr><td><code>nav</code><td>integer<td>&#x2717;<td>The number of deleted navmeshes reported for the dirty plugin. If the number is unknown or zero, this field should not be supplied.