iemod_spec

Specification of the IEMOD file format

Version 0.10.0

The IEMOD format is intended to be a platform-independent distribution
format for modifications for games using the Infinity Engine, using
WeiDU for installation.

An IEMOD file is a ZIP archive using either no compression or
compression with the DEFLATE algorithm (compression method 8). The
file must have the extension ".iemod" and the archive must not span
multiple files or be segmented, nor shall it be encrypted, constitute
or contain patched data, or contain any provisions for
self-extraction. All file and directory names must be encoded in
UTF-8.

Of the files contained within the archive, there must be a WeiDU TP2
file either in the toplevel or within a directory that is itself
located in the toplevel. If the TP2 file is located within a
directory, its file name must exactly match the name of the directory.

The IEMOD file must not include file or directory names containing
characters listed in table forbidden-characters, or files listed in
table forbidden-files and it must not, in its toplevel, contain
directories listed in table toplevel-dirs, or files listed in table
toplevel-files.

The IEMOD file may exclude files and directories listed in table
may-exclude.


Table forbidden-characters
```
<
>
:
"
/
\
|
?
*
'\0' (NUL)
```

Table forbidden-files
```
CON	PRN	AUX	NUL	COM0	COM1
COM2	COM3	COM4	COM5	COM6	COM7
COM8	COM9	LPT0	LPT1	LPT2	LPT3
LPT4	LPT5	LPT6	LPT7	LPT8	LPT9
```

Table toplevel-dirs
```
CD0
CD1
CD2
CD3
CD4
CD5
CD6
cache
characters
data
debugs
dlc
lang
movies
mplayer
mpsave
music
override
portraits
save
script compiler
scripts
sounds
temp
tempsave
workshop
```

Table toplevel-files
```
baldur.exe
bgmain.exe
chitin.key
dialog.tlk
dialogf.tlk
weidu.log
weidu.conf
```

Table may-exclude
```
__macosx/
$RECYCLE.BIN/
backup/

.*
*.7z
*.bak
*.bat
*.iemod
*.rar
*.tar*
*.tmp
*.zip
bgforge.ini
Thumbs.db
ehthumbs.db
```