namedisplaydisplayconditiontypecontentconditionsubs%1%, %2%, etc.), where the numbers correspond to the position of the substitution string in this list to use, to denote where these strings are to be substituted.
There are three message types: @@ -213,9 +214,10 @@ display: 'OBSE v18+'
| Key Name | Required | Notes |
|---|---|---|
str | ✓ | The actual message content string. Double-quoted URLs will be hyperlinked in the LOOT report. See URL Hyperlinking for details. + |
str | ✓ | The actual message content string. |
lang | ✓ | The language that str is written in, given as a POSIX language code. The languages LOOT supports are given in Language Codes.
|
LOOT supports formatting of messages using GitHub Flavored Markdown. Support is provided by the Marked library (v0.3.2). Strings that get substituted into messages, such as file display names and dirty info utility strings, also support the same formatting options.
LOOT handles messages and languages as follows:
content value is a list of localised content structures, then the first structure with a language that matches LOOT's current language will be used as the message's content if displayed. If there are no matches, then the first structure in English will be used.
Examples (translations by Google):
File URLs must begin with For labelled URLs, the syntax is For unlabelled URLs, the syntax is Note that the URLs given as part of a location data structure should not be labelled or enclosed in less-than or greater-than signs, as they consist of raw URL data, rather than text to be displayed in a message.
- Examples:
- While
- Condition strings can be used to ensure that data is only acted on by LOOT under certain circumstances. They are very similar to boolean conditional expressions in programming languages such as Python, though more limited. Their EBNF grammar is:
This document is part of the LOOT documentation. Different versions of LOOT may have varying levels of support for the syntax detailed in this document. Such variation in support is detailed in the table below. Unless otherwise noted, all syntax changes are backwards-compatible (ie. you can use the features without breaking the masterlist for users on older versions).
+
+type: say
condition: 'file("foo.esp")'
@@ -245,6 +246,17 @@ would be displayed as
отмечать: An alternative example link, with no translations.
+In English,
+type: say
+content: 'A newer version of %1% [is available](%2%).
+subs:
+ - 'this plugin'
+ - 'http://www.example.com'
+
+would be displayed as
+
+Note: A newer version of this plugin is available.
+
Location Data Structure
@@ -274,7 +286,7 @@ ver:
Key Name Data Type Required Notes
crchexadecimal integer ✓ The CRC checksum of the dirty plugin, before cleaning. LOOT displays the CRCs of installed plugins in its report. The 8-character CRC should be preceded by 0x so that it is correctly interpreted.
- utilstring ✓ The utility that should be used to clean the plugin. This field supports URL Hyperlinking, and it is recommended that a URL to the game's cleaning guide is supplied.
+ utilstring ✓ The utility that should be used to clean the plugin.
itminteger ✗ The number of identical-to-master records reported for the dirty plugin. If the number is unknown, this field should not be supplied. If the number is known and zero, this field should be supplied.
udrinteger ✗ The number of undeleted records reported for the dirty plugin. If the number is unknown, this field should not be supplied. If the number is known and zero, this field should be supplied.
navinteger ✗ The number of deleted navmeshes reported for the dirty plugin. If the number is unknown, this field should not be supplied. If the number is known and zero, this field should be supplied.
@@ -331,22 +343,6 @@ msg:
content: 'Do not clean. "Dirty" edits are intentional and required for the mod to function.'
-
- URL Hyperlinking
-display strings and message content strings (including the strings in localised content structures) that contain recognised URLs have them displayed as hyperlinks in the LOOT report.
-file:, http: or https:, and be written according to the following subset of Markdown syntax. Note that LOOT does not recognise additional Markdown syntaxes to those given below.
-[label](url). A single optional space may be included between the closing square bracket and the opening parenthesis, ie. [label] (url).
-<url>. The URL shall be used as its own label.
-'This [string](https://en.wikipedia.org/wiki/String_(computer_science)) contains a labelled hyperlink.'
-would be displayed as
-This string contains a labelled hyperlink.
-'This string (see: <https://en.wikipedia.org/wiki/String_(computer_science)>) contains an unlabelled hyperlink.'
-both get displayed as
-This string (see: https://en.wikipedia.org/wiki/String_(computer_science)) contains an unlabelled hyperlink.
-
Condition Strings
[ negator ], function, { junctor, [ negator ], function } ;
@@ -454,3 +450,16 @@ both get displayed as
Copyright (C) 2012—2014 WrinklyNinja
See the file LOOT ReadMe.html
for copying conditions.
+
+Feature Support
+
+
+
LOOT Version
+ Feature <= 0.6 0.7
+ GitHub Flavored Markdown message formatting Only URL hyperlinking is supported, for file:, http: and https: URLs, using the [label](url) and <url> syntaxes.LOOT uses the Marked library (v0.3.2) to provide support for most of GitHub Flavored Markdown, minus the GitHub-specific features (like @mentions, issue/repo linking and emoji).
+ Message string substitution (ie. sub:)Not supported. Support planned, but not yet implemented in the latest alpha release.
+ YAML merge keys (ie. <<:)Not supported. Support planned, but not yet implemented in the latest alpha release.
+