Syntax
Arguments
Parent directory containing the candidate mods as subfolders.
Output directory where overlay WADs are written.
Required Flags
Path to the game folder to build against. This flag is required for overlay building.
Slash-separated list of subfolder names within
<mods_dir> to include, in apply order (e.g., ModA/ModB/ModC).Optional Flags
Exclude TFT assets when indexing the game.
Don’t error on conflicts; later mods in the list win.
Behavior
Themkoverlay command performs the following operations:
1. Safety Processing
Removes overlay-unsafe entries (e.g.,*.SubChunkTOC) to avoid collisions with the game.
2. Conflict Resolution
- Resolves conflicts within each individual mod
- Resolves conflicts across the mod list in the order specified
- By default, errors on conflicts unless
--ignoreConflictis set - When conflicts are ignored, later mods in the list take precedence
3. Overlay Generation
- Merges all selected mods into a unified overlay
- Writes the merged overlay to
<overlay_dir> - Cleans up stray WAD files
Mod Apply Order
Mods are applied in the order specified in the--mods flag. This order is crucial for conflict resolution:
BaseThemeis applied firstCustomSkinsis applied second (overrides conflicting BaseTheme files)SoundPackis applied last (takes precedence over both)
Examples
Build overlay with conflict handling
- Scans
./Modsdirectory forMyModAandMyModBsubfolders - Applies mods in order (MyModA, then MyModB)
- Builds overlay against the game at
/games/LoL - Ignores conflicts (MyModB wins on conflicts)
- Writes overlay to
./Overlay
Build overlay without TFT assets
- Excludes TFT assets during game indexing
- Applies SkinMod and AudioMod in order
- Creates Summoner’s Rift-only overlay
Strict conflict checking
- Does NOT use
--ignoreConflict - Will error if conflicts are detected between mods
- Useful for ensuring mods are compatible
Use Cases
- Multi-mod installation: Combine multiple mods into a single overlay
- Conflict management: Control which mod wins in case of file conflicts
- Performance optimization: Create a single overlay instead of loading multiple mods
- Mod testing: Test mod combinations before applying to game
- Distribution: Create pre-configured mod packs
Troubleshooting
Conflict Errors
If you encounter conflict errors:- Add
--ignoreConflictflag to allow later mods to override - Adjust mod order in
--modsto prioritize preferred mods last - Remove conflicting mods from the list
Missing Mods
Ensure mod names in--mods exactly match subfolder names in <mods_dir> (case-sensitive).