loot/libloot
0
0
Fork 0
mirror of https://github.com/loot/libloot.git synced 2026-07-27 14:16:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Document the group metadata syntax

Browse Source
This commit is contained in:
Oliver Hamlet
2018-03-17 18:26:36 +00:00
parent 9ba600c46b
commit fdb4e46542
6 changed files with 114 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/metadata/data_structures/plugin.rst
+16
View File
@@ -15,6 +15,21 @@ This is the structure that brings all the others together, and forms the main co
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``.
.. describe:: group
``string``
The name of the group the plugin belongs to. If unspecified, defaults to ``default``.
The named group must be exist when LOOT sorts plugins, but doesn't need to
be defined in the same metadata file. If at sort time the group does not
exist, a sorting error will occur.
A plugin must load after all the plugins in the groups its group is defined to
load after. Group loading is resolved recursively. For example, if group C
loads after group B, and group B loads after group A, a plugin in C must load
after all the plugins in A even if no plugins in B are installed.
.. describe:: priority
``integer``
@@ -99,6 +114,7 @@ Key Merge Behaviour (merging B into A)
=============== ==================================
name Not merged.
enabled Replaced by B's value.
group Replaced by B's value.
priority Replaced by B's value, unless that value is ``0`` and it was not explicitly set.
global_priority Replaced by B's value, unless that value is ``0`` and it was not explicitly set.
after Merged. If B's file set contains an item that is equal to one already present in A's file set, B's item is discarded.