1GFF2XML(1)                BSD General Commands Manual               GFF2XML(1)
2

NAME

4     gff2xml — BioWare GFF to XML converter
5

SYNOPSIS

7     gff2xml [options] input_file [output_file]
8

DESCRIPTION

10     gff2xml converts BioWare's GFF files (versions V3.2/V3.3 and V4.0/V4.1)
11     into human-readable XML.  GFF are hierarchical data files, similar to XML
12     in concept, but stored in binary.  As such, these files are used as a
13     basis for many of the file formats found in the BioWare games.  For exam‐
14     ple, an UTC file is a GFF holding a template for a creature, while a GUI
15     file is a GFF describing an in-game menu.
16
17     Both version 3 of the format (V3.2/V3.3) and version 4 (V4.0/V4.1) are
18     supported.  While they are similar, the 4th version carries several
19     changes to make the files more efficient to read in-game.  This includes
20     replacing the string field names (which map to XML tags) with numerical
21     identifiers, resulting in converted XML files that are stripped of their
22     meaning.  To compensate, this tool adds readable aliases to many of these
23     numerical identifiers, giving them back their meaning.  Unfortunately,
24     not all of them are known.  Most notably, the identifiers introduced in
25     Sonic Chronicles: The Dark Brotherhood and Dragon Age 2 are still miss‐
26     ing.
27
28     The changes in the minor versions (V3.2 vs. V3.3 and V4.0 vs.  V4.1) are
29     less significant.  V3.3 simply changes which languages are supported, and
30     V4.1 adds a common string table at the start of the file.  Both of these
31     additions are handled transparently.
32

OPTIONS

34     -h
35     --help
36           Show a help text and exit.
37     --version
38           Show version information and exit.
39     --cp1252
40           Read GFF4 strings as Windows CP-1252.  Usually, strings in version
41           4 of the GFF format are encoded in little-endian UTF-16.  But some
42           files store them as Windows CP-1252 instead.  Since there's no
43           clean way to autodetect the different encoding, this switch manu‐
44           ally selects Windows CP-1252.
45     --nwnpremium
46           The GFF files found in the encrypted HAK files of Neverwinter
47           Nights premium modules are deliberately broken.  This options tells
48           gff2xml to work around the brokenness.
49     input_file
50           The GFF file to convert.
51     [output_file]
52           The XML file will be written there.  If no output file is speci‐
53           fied, the XML data is written to stdout.  The encoding of the XML
54           stream is always UTF-8.
55

EXAMPLES

57     Convert the GFF file1.utc into an XML file:
58
59           $ gff2xml file1.utc file2.xml
60
61     Convert the GFF file1.utc into an XML file on stdout:
62
63           $ gff2xml file1.utc
64
65     Convert the GFF file1.utc, which uses Windows CP-1252 strings:
66
67           $ gff2xml --cp1252 file1.utc file2.xml
68

SEE ALSO

70     convert2da(1), fixpremiumgff(1), tlk2xml(1)
71
72     More information about the xoreos project can be found on its website:
73     https://xoreos.org/.
74

AUTHORS

76     This program is part of the xoreos-tools package, which in turn is part
77     of the xoreos project, and was written by the xoreos team.  Please see
78     the AUTHORS file for details.
79
80BSD                            November 14, 2015                           BSD
Impressum