Guides/02

Plugins

Inspect, check, clean and compare plugin files.

A plugin is an .esp, .esm or .esl file. Each command in this section works on a whole file.

Inspect

esx plugin info MyMod.esp
esx plugin records MyMod.esp --sig WEAP --new-only
esx plugin groups MyMod.esp

Use --with Other.esp to load more plugins with the target. Use --no-masters to inspect a plugin when its masters are missing.

Check and clean

plugin check finds unresolved FormIDs, wrong reference types, unknown enum values and decoding errors. Add --fail-on-issues to return exit code 7 when it finds a problem.

esx plugin check MyMod.esp --fail-on-issues

plugin clean does the same work as Quick Auto Clean in xEdit. It removes records that are identical to the master. It also undeletes and disables deleted references. Without --apply, it only reports.

esx plugin clean MyMod.esp
esx plugin clean MyMod.esp --apply

Conflicts and differences

esx plugin conflicts MyMod.esp --only-conflicts
esx record conflicts MyMod.esp edid:MyWeapon
esx plugin diff Old.esp New.esp

plugin diff compares two versions of a plugin. It lists added, removed and changed records with the changed fields.

Masters

esx plugin masters list MyMod.esp
esx plugin masters add MyMod.esp DLCRobot.esm
esx plugin masters clean MyMod.esp
esx plugin masters sort MyMod.esp

esx rewrites FormIDs when you add a master.

Light plugins

esx plugin esl-check MyMod.esp
esx plugin compact-esl MyMod.esp --set-flag
esx plugin next-formid MyMod.esp

esl-check tells you if the plugin can have the ESL flag. compact-esl renumbers new records into the light plugin range.

Merged patch

esx loadorder merged-patch A.esp B.esp -o Patch.esp

The patch merges leveled lists, container items, faction relations and keywords.