diff --git a/docs/LOOT Metadata Syntax.html b/docs/LOOT Metadata Syntax.html index 24a15d7a..90acf474 100644 --- a/docs/LOOT Metadata Syntax.html +++ b/docs/LOOT Metadata Syntax.html @@ -361,10 +361,10 @@ nav: 0 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). Plugins that don't change any of the same records are not compared, unless: -

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. +

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-empty) 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. diff --git a/docs/LOOT Readme.html b/docs/LOOT Readme.html index 5df9cf9a..161dab8f 100644 --- a/docs/LOOT Readme.html +++ b/docs/LOOT Readme.html @@ -191,11 +191,6 @@ paper-icon-button::shadow #icon {

Using LOOT

-
- -
LOOT's user interface. The header bar is at the top, containing the main menu, game menu, masterlist update button and sorting button. On the left is the sidebar, which has the Plugins and Filters tabs, and the content filter at the bottom. On the right is the content area, which holds cards for summary information, general messages, and each installed plugin.
-
-

Initialisation

When LOOT is run, it will attempt to detect which of the supported games are installed. If a default game has been set, LOOT will run for it, otherwise it will run for the same game as it last ran for. If the relevant game cannot be detected, or if there is no record of the last game LOOT ran for, it will run for the first detected game. @@ -210,53 +205,81 @@ paper-icon-button::shadow #icon {

The Header Bar

-

The header bar provides access to LOOT's main features. Most of these features get disabled while there is at least one plugin editor open, so if you're trying to use an option that has been greyed out, first close any editors you have open. +

+
+
+ +
+
+
LOOT's header bar, divided into sidebar and panel areas. The sidebar area contains the plugins and filters tabs. From left to right in the panel area are the Jump To General Information button, the game menu, and the sorting, masterlist update and main menu buttons. The game menu, masterlist update button and sorting button have been disabled, as a plugin metadata editor is open.
+
-

Main Menu

- -

The button opens the main menu. A few items may not be obvious in their function: -

    -
  1. Redate Plugins is provided so that Skyrim modders may set the load order for the Creation Kit. It is only enabled for Skyrim, and changes the timestamps of the plugins in its Data folder to match their current load order. A side effect of changing the timestamps is that any Steam Workshop mods installed will be re-downloaded. -
  2. Copy Content copies the data displayed in LOOT's cards as YAML-formatted text. -
  3. Refresh Content re-scans the installed plugins' headers and regenerates the content LOOT displays. This can be useful if you have made changes to your installed plugins while LOOT was open. -
+

The header bar provides access to LOOT's main features. Most of these features get disabled while there is at least one plugin editor open, so if you're trying to use an option that has been greyed out, first close any editors you have open.

Game Menu

-

The game LOOT is currently run for is displayed in the header bar, and clicking on it will allow you to switch to another game from the drop-down list that is displayed. Games which do not have installs detected are greyed out and cannot be selected. +

LOOT's active game can be changed by clicking on it in the header bar, and selecting another game from the menu that is displayed. Games that have no install detected are disabled have their menu items disabled.

Masterlist Update & Sorting

-

The button updates LOOT's masterlist for the current game to the latest available revision. If the latest revision contains errors (eg. due to typos), then LOOT will roll back until it finds a revision that works. +

The masterlist update process updates the active game's masterlist to the latest revision at the location given by the game's masterlist repository settings. If the latest revision contains errors, LOOT will roll back to the latest revision that works. -

The button begins LOOT's sorting process. By default, sorting first updates the masterlist. LOOT then sorts your plugins according to a combination of data from the plugins themselves, and any metadata they may have. If a cyclic interaction is detected (eg. A depends on B depends on A), then sorting will fail. Once sorting has calculated a new load order, the plugin cards are sorted into that order, and the and buttons are replaced with Apply and Cancel buttons, which apply and discard the calculated load order respectively. +

By default, sorting first updates the masterlist. LOOT then calculates a load order for your plugins, using their internal data and any metadata they may have. If a cyclic interaction is detected (eg. A depends on B depends on A), then sorting will fail. + +

Once LOOT has calculated a load order, the plugin cards are sorted into that order. The masterlist update and sorting buttons are replaced with Apply and Cancel buttons, which apply and discard the calculated load order respectively. Changing games is disabled until the calculated load order is applied or discarded.

LOOT is able to sort plugins ghosted by Wrye Bash, and can extract Bash Tags and version numbers from plugin descriptions. Provided that they have the Filter Bash Tag present in their description, LOOT can recognise filter patches and so avoid displaying unnecessary error messages for any of their masters that may be missing. +

Any errors encountered during sorting or masterlist update will be displayed on the General Information card. + +

Main Menu

+ +

A few items in the main menu are not self-explanatory: +

+

Plugin Cards & Sidebar Items

-

Each plugin is displayed on its own card, which displays all the information LOOT has for that plugin, and holds its metadata editor. Each plugin also has an entry in the Plugins tab of the sidebar. The sidebar entry contains the plugin's name and icons for plugins that load BSAs or have user metadata. Clicking on a plugin's sidebar entry will navigate to its card in the main content area. +

+
+
+ +
+
+
Examples of plugin cards.
+
-

The card's button opens the plugin's menu, which provides access to a few plugin-specific features, including a conflict filter and access to its metadata editor. These are explained in later sections. +

Each plugin is displayed on its own card, which displays all the information LOOT has for that plugin, and provides access to plugin-specific functionality, including its metadata editor. Each plugin also has an item in the sidebar's Plugins tab. The sidebar item contains the plugin's name and icons for plugins that load BSAs or have user metadata. Clicking on a plugin's sidebar item will jump to its card, while double-clicking will jump to its card and open its metadata editor. -

The Copy Metadata option copies the plugin's metadata in the same format that it is saved in, which makes it an easy way to share any edits you make with masterlist maintainers, for example. If posting the metadata in an online forum that supports BBCode (as most forums do), be sure to wrap it in [code] tags, eg. [code]copied text[/code], so that the spaces are not removed by the forum software. +

The plugin card's header holds the following information, some of which is only displayed if applicable: +

    +
  1. The Active Plugin icon. +
  2. The plugin name. +
  3. The plugin's version number, extracted from its description field. +
  4. The plugin's CRC, which can be used to uniquely identify it. CRCs are only displayed after they have been calculated during conflict filtering or sorting. +
  5. The Empty Plugin icon. +
  6. The Loads BSA icon. +
  7. The Has User Metadata icon. +
  8. The plugin menu button, which provides access to a few plugin-specific features, including a conflict filter and access to its metadata editor. These are explained in later sections. +
-

The dummy plugin icon and CRC values are only displayed on plugin cards after plugins have been fully loaded, which happens during conflict filtering and sorting. LOOT will also display a version number if one can be found in the plugin's description field. +

Bash Tag suggestions and messages are displayed below the plugin card's header. -

If LOOT suggests any Bash Tags to be added, they will be displayed in green text, while any Bash Tags to be removed will be displayed in red text. Users generally don't need to do anything with this information, as if they're using Wrye Bash it will automatically apply LOOT's suggestions, and if they're not using Wrye Bash then this information doesn't apply. +

If LOOT suggests any Bash Tags to be added, they will be displayed in green text, while any Bash Tags to be removed will be displayed in red text. For completeness, the list of Bash Tags to add will include any Bash Tags that are already specified in the plugin's description field. Users generally don't need to do anything with this information, as if they're using Wrye Bash it will automatically apply LOOT's suggestions, and if they're not using Wrye Bash then this information doesn't apply. -

Below the card header and any Bash Tag suggestions, LOOT will display any messages it has for that plugin. LOOT's plugin messages are a valuable resource, acting as a means of providing users with information that they might otherwise not obtain. It is important for a stable, healthy game that you act on any messages that require action. - -

If you think a message suggests an unnecessary action, report it to an official LOOT thread. If you encounter a message that is non-conditional, ie. it suggests an action but is still displayed on subsequent runs of LOOT after the action has been carried out, also report it to an official LOOT thread, so that it can be made conditional. +

LOOT's plugin messages are a valuable resource, acting as a means of providing users with information that they might otherwise not obtain. It is important for a stable, healthy game that you act on any messages that require action. If you think a message suggests an unnecessary action, report it to an official LOOT thread. If you encounter a message that is non-conditional, ie. it suggests an action but is still displayed on subsequent runs of LOOT after the action has been carried out, also report it to an official LOOT thread, so that it can be made conditional.

Filters

-

Clicking the Filters tab in the sidebar will replace the sidebar's plugin list with a list of filter toggles that can be applied to hide various combinations of plugins and other content. The available filter toggles are: +

Clicking the Filters tab in the sidebar will replace the sidebar's plugin list with a list of filter toggles that can be applied to hide various combinations of plugins and other content. The available filter toggles are: