Skip to content

Commit 4b6176b

Browse files
committed
Small mod flag docs
1 parent 7e36871 commit 4b6176b

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/plugins/Compaction.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ Bethesda mod files come in a few compaction styles:
77

88
Compacting mods intelligently allows the game to load more mods overall. These docs will not go into the gritty specifics of that.
99

10+
## Setting Small Master Flag
11+
12+
To create a small/light master, set the header flag on your mod:
13+
14+
```cs
15+
var mod = new SkyrimMod(ModKey.FromFileName("MyMod.esp"), SkyrimRelease.SkyrimSE);
16+
mod.ModHeader.Flags |= SkyrimModHeader.HeaderFlag.Small;
17+
```
18+
19+
This creates a "flagged ESP" - an `.esp` file with the small master flag set in its header. The game will treat it as a light master.
20+
21+
!!! note "ModType vs HeaderFlag"
22+
`ModType.Light` (used in ModKey) affects the file extension (`.esl`), while `HeaderFlag.Small` sets the internal header flag. Modern practice typically uses flagged ESPs (`.esp` files with the small master flag set).
23+
1024
## Compacting
1125

1226
`ModCompaction` is a static class that offers the ability to compact a mod to the given acceptable range for Small/Medium/Full masters.

0 commit comments

Comments
 (0)