Mod List Page

Mator Created Sep 30 2016 - Updated Nov 19 2016 Mod picker

The mod list page on Mod Picker is the page where you can view and edit Mod Lists. You can access the Edit mode of the page if you are an author of the mod list.

Header section

General information

The left part of the header section of the mod list page displays the mod lists title, author, date created, and date updated. You can click on the author's username to go to their profile.

Actions, status, and visibility

The right part of the header contains actions and the mod list's status. Actions include editing the mod list, reporting it, favoriting it and cloning it (note: cloning mod lists is not yet functional).

You will only see the Edit button if you have permission to update the mod list. Clicking the edit button will toggle editing mode. While in edit mode you can make changes on all tabs of the mod list except the comments tab. Once you're done making your changes you can click the Save button to save your changes to the server. If you make a mistake you can click the Reset button to clear your changes. (you can also refresh or the page or leave it and come back to it to clear your changes).

NOTE: When viewing your active mod list you will be in edit mode by default. On all other mod lists you will be in view mode by default.

While editing a mod list, the edit button will be replaced with the View button. The view button will allow you to toggle back to viewing the mod list without discarding your changes. If you have toggle viewing mode and ahve unsaved changes on the mod list, a warning message will display.

Favoriting a mod list allows you to track when it updates, you can view a list of mod lists you've favorited on your profile page. Clicking the favorite button a second time unfavorites the mod list.

The mod list status is set by the author and can be Under Construction, Testing, or Completed. This status indicates where the mod list is in its development.

The author of the mod list can also change the visibility of the Mod List to Private, Unlisted, or Public. Private mod lists can only be accessed by their authors and the site staff. Unlisted mod lists can be accessed by anyone with the link, but aren't publicly listed on the mod lists index. Public mod lists are publicly available and listed on the mod lists index.

If you're the author of the mod list and the mod list is your active mod list, the Active status box will be displayed. Adding mods from other parts of the site go into your active mod list. You can set your active mod list from the user settings mod lists tab.

Details tab

View mode

The details tab displays three main things in view mode:

  • The mod list description, styled with markdown. Some examples of content for mod list descriptions are:
    • A more detailed explanation of the status of the mod list
    • The general idea behind the mod list
    • Notes about mods, tools, plugins, or config files in the mod list
    • System specs for using the mod list
  • The export dropdown. The currently supported export options are:
    • modlist.txt: Exports the mod install order for the mod list for use with Mod Organizer. See the install order help page for more information.
    • plugins.txt: Exports the plugin load order for the mod list. See the load order help page for more information.
    • links.txt: Exports links to download all of the mods and tools in the mod list, in order.
    • More options may be made available in the near future.
  • The mod list tags. See the tags help page for more information.

Edit mode

The details tab allows you edit the description and mod list options in edit mode. The options available are:

  • Name: The mod list's name.
  • Status: The status of the mod list. (Under Construction, Testing, or Completed)
  • Visibility: The visibility of the mod list. (Private, Unlisted, or Public)
  • Collection: If checked, the mod list will be marked as a collection. Collections are lists of mods that are intended to be added to other mod lists.
  • Lock Tags: If checked only you and site staff will be able to add tags to the mod list.
  • Delete: If checked the mod list will be deleted. See the content deletion policy help page for more information.

Mods, tools, and plugins tabs

The mods, tools, and plugins tabs offer very similar functionality.

Quick bar

The quick bar is a bar that appears at the top of the mods, tools, and plugins tab.

Counters

In both view and edit mode the quick bar displays the counters for issues/missing requirements as specified below:

  • Tools tab
    • Number of missing required tools
  • Mods tab
    • Number of unresolved compatibility/install order issues
    • Number of ignored compatibility/install order issues
    • Number of missing required mods
  • Plugins tab
    • Number of unresolved compatibility/load order issues
    • Number of ignored compatibility/load order issues
    • Number of missing required plugins

Quick add

In edit mode the quick bar offers a way to quickly add a tool/mod/plugin to your mod list by entering the name/filename into a search input and selecting the item to add from the dropdown of results.

Manage plugins

The plugins tab offers a more in-depth way to manage the plugins in your mod list through the manage plugins modal. Click the manage plugins button to open the modal.

You can sort by any of the columns in the manage plugins modal by clicking the column header. The modal displays the following columns:

  • Active: Displays a checkbox which is checked if the plugin is active in your mod list. You can toggle a plugin in your mod list by clicking the checkbox.
  • Filename: The filename of the plugin. You can click on this to view the plugin's analysis.
  • Mod Index: The install order index of the mod the plugin is associated with.
  • Mod: The name of the mod the plugin is associated with. You can click on this to view the mod page.
  • Mod Option: The mod option the plugin is associated with.

View modes

There are two view mods for the mods and tools tabs, Grid View and List View. List view displays more information (with customizable columns) while grid view displays mod images. The mods tab and the tools tab default to grid view. The plugins tab only offers list view.

Groups

The mods, tools, and plugins tabs all allow you to use groups. Groups allow you to categorize items for organizational purposes. You can create a group on any of these tabs by clicking the Add Group button.

You can remove a group by clicking the X button. Removing a group does not remove tools, mods, or plugins in that group from your mod list.

Sort install/load order

Mod Picker offers an algorithm to automatically sort mod install order and plugin load order. A button is displayed on the mods tab and the plugins tab to Sort Install Order and Sort Load Order respectively.

Clicking the sort install/load order button will start a process that automatically sorts the install/load order of mods/plugins in your mod list. The algorithm sorts mods/plugins into groups, organizes the groups by priority, and resolves any install/load order issues between them.

Custom groups will be preserved when sorting install/load order.

This feature is fairly untested, and will only yield an install/load order as accurate as the install/load order notes on Mod Picker allow. Additional manual tweaking may be required.

Custom items

If you want to list a mod, tool, or plugin in your mod list which is not present on Mod Picker you can represent that it using a custom item. Custom items allow you to specify a name and a plain-text description.

NOTE: Mod Picker will not have any metadata for custom items. That means no compatibility, install order, or load order notes, no asset file information, and no plugin information. The more custom items you use the less you can leverage the powerful features that Mod Picker mod lists offer.

Custom mods and tools

You can add a custom mod or tool to your mod list by clicking the Add Custom Mod or Add Custom Tool button on the mods or tools tab, respectively.

A modal window will appear when you first add a custom mod/tool to your mod list which allows you to set its name and description. You can get back to this modal at any time by clicking the gear button for the custom mod/tool in list view (list view gear) or grid view (grid view gear).

Custom mods and tools allow you to specify a URL as well as a name and description. This URL should link to an official source for the mod or tool such as Nexus Mods, Steam Workshop, Lover's Lab, or GitHub. If you use an official source for the mod and the mod is later added to Mod Picker, your custom mod entry will be automatically substituted with a normal mod entry.

NOTE: DO NOT, UNDER ANY CIRCUMSTANCES, LINK TO MOD DOWNLOADS THAT WERE NOT AUTHORIZED OR PERMITTED BY THE AUTHOR OF THE MOD. This is considered promoting piracy, and may result in the suspension or termination of your Mod Picker account.

Custom plugins

You can add a custom plugin to your mod list by clicking the Add Custom Plugin button on the plugins tab. Custom plugins are very useful for representing custom or generated patches/plugins.

A modal window will appear when you first add a custom plugin to your mod list which allows you to set its filename and description. You can get back to this modal at any time by clicking the gear button for the custom plugin.

Moving and removing items

You can remove a mod, tool, or plugin while in edit mode by clicking the X in grid view or by clicking the Remove button in list view.

You can adjust the order of mods, tools, and plugins, including moving them into/out of groups in your mod list using drag and drop.

Mod options

Both tools and mods support manging mod options. Mod options can be optional/alternative mod installation archives or FOMOD/BAIN installer options. What mod options you enable will determine what plugins are available to use on the plugins tab as well as what asset conflicts are listed on the analysis tab.

To manage the options associated with a tool/mod in your mod list, click on the gear button for the mod/tool in list view (list view gear) or grid view (grid view gear).

NOTE: If a mod/tool has does not have multiple mod options no gear button will be displayed.

Edit mod options modal

The edit mod options modal displays a list of all of the mod options associated with a mod/tool. You can sort by any of the columns by clicking the column header. The available columns are as follows:

  • Active: Displays a checkbox which is checked if the mod option is active in your mod list. You can toggle the mod option in your mod list by clicking the checkbox.
  • Name: The display name of the mod option. You can hover over the mod option to see the raw name (archive filename or exact FOMOD/BAIN install option name).
  • Default: Displays a value of "Yes" or "No" depending on whether or not the mod option was flagged as being a default option (the base/main archive for a mod is usually marked as default).
  • File Size: For archive mod options this is the size of the mod archive. For FOMOD/BAIN installer options this is the size uncompressed size of the asset files associated with the mod option.
  • Asset Files: The number of asset files associated with the mod option.
  • Plugins: A list of the plugin filenames associated with the mod option. NOTE: Sorting by this column sorts by the number of plugins associated with the mod option.

Required mods, tools, and plugins

The required mods, tools, and plugins sections allows you to view mods, tools or plugins that are required by other mods, tools, or plugins in your mod list. One entry is listed for each requirement, with a list of the items that require it. If more than 2 items require the same thing, the list will be truncated. You can hover over the and X more text to view a list of all of the items that require it.

Modes

The section has two modes: missing and all. You can toggle the mode by clicking on the link in the right side of the header, which will say show all or show missing, depending on the mode you are currently in. The default mode, missing, displays only missing requirements. The all mode shows all required items, including ones that are present in your mod list.

Resolution

While in the missing view mode, automatic resolution options are offered. Clicking the Resolve All button in the header will resolve all missing all missing requirements by adding the missing items to your mod list. You can resolve individual missing requirements by clicking the Add Requirement button to add the required item to your mod list, or by clicking the Remove Requirers button to remove all of the items that require the missing item from your mod list.

The remove requirers resolution option on the tools tab is only available if you have visited the mods tab. If you have not visited the mods tab of your mod list, it will be disabled.

Compatibility, install order, and load order issues

The mods tab displays compatibility notes with a status of incompatible, partially incompatible, or compatibility mod. The mods tab also displays install order notes.

The plugins tab displays compatibility notes with a status of compatibility option or make custom patch. The plugins tab also displays load order notes.

Modes

Each issue section has two modes: unresolved and all. You can toggle the mode by clicking on the link in the right side of the header, which will say show all or show unresolved, depending on the mode you are currently in. The default mode, unresolved, displays only unresolved issues. The all mode shows all issues, including ones that have been ignored or resolved.

Resolution

While in edit mode, automatic resolution options are offered for compatibility, install order, and load order issues. Clicking the Resolve All button in the header will resolve all unresolved issues.

NOTE: Compatibility notes which do not have a position resolution option such as adding a mod, mod option, or plugin to your mod list will not be resolved by clicking the resolve all button. You must resolve or ignore these issues individually.

You can resolve individual issues by clicking the buttons in the resolution column. What resolution options are provided depends on the type of issues you're dealing with.

Ignoring issues

You can choose to ignore any note/issue in your mod list. This is primarily intended to be used when you feel a note is incorrect.

To ignore an issue, click the Ignore Issue button. To unignore an issue, click the Unignore Issue button.

Note: You can only view ignored issues by switching the section the issue is from to *show all** mode.*

Compatibility note resolution options

Compatibility notes offer different resolution options depending on their status.

  • Remove the first mod: Removes the first mod the compatibility note is about. (Available on all compatibility notes)
  • Remove the second mod: Removes the second mod the compatibility note is about. (Available on all compatibility notes)
  • Add compatibility mod: Adds the compatibility mod to your mod list. (Available on compatibility notes with the compatibility mod status)
  • Add compatibility mod option: Adds the compatibility mod option to your mod list. (Available on compatibility notes with the compatibility option status and a specified mod option)
  • Add compatibility plugin: Adds the compatibility plugin to your mod list. (Available on compatibility notes with the compatibility option status and a specified compatibility plugin)
  • Add custom patch: Adds a custom plugin for the compatibility note to your mod list. (Available on compatibility notes with the make custom patch status)

Certain resolution options on compatibility notes on the plugins tab will only be available if you have visited the mods tab. If you have not visited the mods tab of your mod list, they will be disabled.

Install order note resolution options

Install order notes offer two positive resolution options:

  • Move the first mod: Moves the mod which needs to be installed first up your install order until it is above the mod which needs to be installed second.
  • Move the second mod: Moves the mod which needs to be installed second down your install order until it is below the mod which needs to be installed first.

Load order note resolution options

Load order notes offer two positive resolution options:

  • Move the first plugin: Moves the plugin which needs to be loaded first up your load order until it is above the plugin which needs to be loaded second.
  • Move the second plugin: Moves the plugin which needs to be loaded second down your load order until it is below the plugin which needs to be loaded first.

Config tab

TODO

Analysis tab

The analysis tab displays statistics and insights for your mod list.

Statistics

  • Mods
    • Number of tools
    • Number of mods
    • Number of custom tools
    • Number of custom mods
  • Plugins
    • Number of (active) plugins
    • Number of (active) master plugins
    • Number of available plugins (from all mod options)
    • Number of custom plugins
  • Config
    • Number of config files
    • Number of custom config files
  • Social
    • Number of tags
    • Number of comments
    • Number of stars
  • Notes
    • Number of compatibility notes
    • Number of install order notes
    • Number of load order notes
    • Number of ignored notes
  • Data
    • Number of BSA files (from active mod options)
    • Number of asset files (from active mod options)
    • Number of records (in all active plugins)
    • Number of override records (in all active plugins)
    • Number of plugin errors (in all active plugins, includes dirty edits such as ITMs)

Conflicting assets

The conflicting assets section displays asset conflicts between your mods/mod options as detected by Mod Picker. Conflicting asset information can be used to tweak your install order so the mods you want to win asset conflicts do so. The section displays the following information:

  • Asset Path: The path to the asset file for which conflicts were detected.
  • Mods: A list of mods and their install orders which override the asset file. The bold green mod is the one that wins the asset conflict. The suffix (BSA) as added to mods which provide the asset file inside of a BSA archive.

Conflicting overrides

Displays all conflicting overrides between the plugins in the mod list. Conflicting overrides can indicate the necessity for conflict resolution patches as produced by Wrye Bash or Mator Smash. Note that not all override conflicts are bad, though they can be indicative of incompatibilities between mods due to the rule of one. Mod Picker only lets you know when two or more mods override the same record - more detailed information requires using an external tool such as TES5Edit.

The conflicting overrides section displays the following information:

  • Master Plugin: The plugin the original version of the record is from. This is usually a Bethesda master file.
  • FormID: The signature and FormID of the record that is being overridden.
  • Plugins: A list of all of the plugins from your mod list that override the record.

Plugin errors

Displays a list of the plugin errors in every plugin active in the mod list, with links to the full analysis for the plugin for details.

Comments tab

The comments tab displays all comments that have been made on your mod list, and allows you to create new comments or reply to existing ones. See the comments help page for more information.