Skip to main content

Syntax

mod-tools export <src_mod_dir> <dst_archive> [--game:<path>] [--noTFT]

Arguments

src_mod_dir
string
required
Source mod folder (must contain META/info.json).
dst_archive
string
required
Output archive path (e.g., MyMod.zip or MyMod.fantome).

Flags

--game
string
Path to the game folder. Optimize using rebase against the game before zipping.
--noTFT
boolean
Exclude TFT assets when indexing the game.

Behavior

The export command performs the following operations:
  1. Internally runs the same optimization as the copy command
  2. Zips the optimized result to <dst_archive>

Optimization Process

  • Resolves internal conflicts
  • Normalizes WAD structure
  • If --game is provided, rebases against game files to reduce size
  • Copies metadata files

Archive Formats

Supported archive extensions:
  • .zip - Standard ZIP archive
  • .fantome - League of Legends mod archive format

Examples

Export with game optimization

mod-tools export ./MyMod ./MyMod.zip --game:/games/LoL
This command:
  • Optimizes MyMod by rebasing against the game
  • Strips unmodified entries
  • Creates MyMod.zip archive with optimized content

Export to Fantome format

mod-tools export ./MyMod ./MyMod.fantome --noTFT
This command:
  • Optimizes MyMod without game rebasing
  • Excludes TFT assets during processing
  • Creates MyMod.fantome archive

Export without optimization

mod-tools export ./MyMod ./MyMod-raw.zip
This command:
  • Exports MyMod with minimal optimization
  • No game rebasing or TFT filtering
  • Creates a basic archive of the mod

Use Cases

  • Mod distribution: Package mods for sharing with other players
  • Size optimization: Create smaller archives by removing unmodified files
  • Format conversion: Convert between ZIP and Fantome formats
  • Backup creation: Archive mods for safekeeping
  • Release preparation: Create final, optimized versions for release

Build docs developers (and LLMs) love