With LOOT, the metadata file syntax is what its masterlists and userlists are written in. If you know YAML, good news: the metadata file syntax is essentially just YAML 1.2. If you don't know YAML, then its Wikipedia page is a good introduction. All you really need to know is: +
The metadata syntax is what LOOT's masterlists and userlists are written in. If you know YAML, good news: the syntax is essentially just YAML 1.2. If you don't know YAML, then its Wikipedia page is a good introduction. All you really need to know is:
globals:
- type: say
content: 'You are using the latest version of LOOT.'
- condition: 'version("LOOT", "1.0.0.0", ==)'
+ condition: 'version("LOOT", "0.5.0.0", ==)'
plugins:
- name: 'Armamentarium.esm'
tag:
@@ -214,7 +214,7 @@ 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.
- lang✓ The language that str is written in, given as an ISO 639-3 language code. The languages LOOT supports are given in Language Codes.
+ lang✓ The language that str is written in, given as a POSIX language code. The languages LOOT supports are given in Language Codes.
LOOT handles messages and languages as follows:
@@ -297,7 +297,13 @@ nav: 0
namestring ✓ Can be an exact plugin filename or a regular expression plugin filename. If the period that precedes the file extension has been escaped (eg. \.esp, \.esm), the string is treated as a regular expression, otherwise it is treated as an exact filename.
enabledboolean ✗ Enables or disables use of the plugin object. Used for user rules, but no reason to use it in the masterlist. If unspecified, defaults to true.
- priorityinteger ✗ Modifies plugin position relative to others that change one or more of the same records, but which are otherwise unrelated (ie. neither plugin lists the other as a master, requirement, or in its after list). A plugin with a higher priority value will load after a plugin with a lower priority value. Value can be anything in the range -2000000000 to 2000000000, and if unspecified defaults to 0.
+ priorityinteger ✗ Modifies plugin position relative to others that change one or more of the same records, but which are otherwise unrelated (ie. neither plugin lists the other as a master, requirement, or in its after list). Plugins that don't change any of the same records are not compared, unless:
+
+ - One of the plugins is a "dummy" plugin, containing only a header record.
+
- One of the plugins has a priority greater than or equal to 1,000,000. In this case, only the modulo (ie. remainder when divided) with 1,000,000 is used when comparing plugin priority values &endash; the rest is only used to signify that the plugin should be compared against all others.
+
+ For example, priority: 153000352 and priority: 352 have equal values when compared, but a plugin with the first priority will be compared against all others, while a (non-dummy) plugin with the second priority will be compared against only those it conflicts with.
+
A plugin with a higher priority value will load after a plugin with a lower priority value. Value can be anything in the range -2000000000 to 2000000000, and if unspecified defaults to 0.
afterfile list ✗ An unordered list of plugins that this plugin must load after, but which are not dependencies. Used for resolving specific compatibility issues and by user rules for specifying custom plugin positions.
reqfile list ✗ An unordered list of files that this plugin requires to be present. This plugin will load after any plugins listed. If any of these files are missing, an error message will be displayed. Intended for use specifying implicit dependencies, as LOOT will detect a plugin's explicit masters itself.
incfile list ✗ An unordered list of files that this plugin is incompatible with. If any of these files are present, an error message will be displayed.
@@ -329,7 +335,7 @@ msg:
URL Hyperlinking
-File 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 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.
URLs must begin with 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.
For labelled URLs, the syntax is [label](url). A single optional space may be included between the closing square bracket and the opening parenthesis, ie. [label] (url).
For unlabelled URLs, the syntax is <url>. The URL shall be used as its own label.
@@ -347,7 +353,7 @@ both get displayed as
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:
[ negator ], function, { junctor, [ negator ], function } ;
The [ negator ], function grammar is referred to as a condition, and two conditions joined by an operator, ie. condition, operator, condition is referred to as a compound condition.
-
Unlike BOSS, which LOOT is based on, LOOT caches the results of condition evaluations, so performance is not really an issue. A regular expression check will still take longer than a file check though, so use the former only when appropriate to do so.
+
LOOT caches the results of condition evaluations, so performance is not really an issue. A regular expression check will still take longer than a file check though, so use the former only when appropriate to do so.
Functions
There are several conditions that can be tested for using the functions detailed in the table below.
@@ -433,14 +439,18 @@ both get displayed as
Language Codes
LOOT supports the following languages and language codes:
- Language ISO 639-3 Code
+ Language POSIX Code
English eng
- Spanish spa
- Russian rus
+ Chinese zh_CN
+ English en
+ French fr
+ Polish pl
+ Brazilian Portuguese pt_BR
+ Russian ru
+ Spanish es
License
This document is part of the LOOT documentation.
-Copyright (C) 2012–2013 WrinklyNinja
+Copyright (C) 2012—2014 WrinklyNinja
See the file LOOT ReadMe.html
for copying conditions.
diff --git a/docs/dev/LOOT Readme.html b/docs/dev/LOOT Readme.html
index 6d06811..3ec8d19 100644
--- a/docs/dev/LOOT Readme.html
+++ b/docs/dev/LOOT Readme.html
@@ -55,15 +55,14 @@ h3{
var {color:#8B4513;}
.teamTableBody td:not(:first-child) {text-align:center;}
- tr.inactive {color:#888;}
dt {margin-bottom:0.5em; margin-top:1em; font-style:italic;}
dd {margin-bottom:0.75em;}