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

NAME

4     xml2ssf — XML to BioWare SSF converter
5

SYNOPSIS

7     xml2ssf [options] [input_file] output_file
8

DESCRIPTION

10     xml2ssf converts XML files created by the ssf2xml(1) tool back into the
11     BioWare SSF format.  For a more in-depth description of SSF files, please
12     see the man page for the ssf2xml(1) tool.
13
14     The format of the input XML is pretty simple and straight-forward.
15
16     <?xml version="1.0" encoding="utf-8" standalone="yes"?>
17     <ssf>
18       <sound id="0" label="Attack" strref="66299">vs_fkillerf_attk</sound>
19       <sound id="1" label="BattleCry1">vs_fkillerf_bat1</sound>
20       <sound id="2" label="BattleCry2" strref="66301"></sound>
21       <sound id="3" label="BattleCry3"></sound>
22     </ssf>
23
24     The root element is “ssf”, with multiple “sound” elements as children.
25     Each “sound” element requires an “id” property, specifying the index of
26     the sound within the SSF file.  Optionally, there can be a “strref” prop‐
27     erty, which denotes the string reference (StrRef) of the text line asso‐
28     ciated with the sound.  The contents of the “sound” element is the file‐
29     name (ResRef) of the sound file to play.
30
31     Because different BioWare games use slightly different versions of the
32     SSF file format, the game for which to create the SSF file has to be
33     specifying on the command line.  Please note that the file versions have
34     different requirements on the input data as well. These requirements are
35     noted below.
36

OPTIONS

38     -h
39     --help
40           Show a help text and exit.
41     --version
42           Show version information and exit.
43     --nwn
44           Create an SSF file fit for use within the game Neverwinter Nights.
45           Sound filenames have to be 16 characters long or less.
46     --nwn2
47           Create an SSF file fit for use within the game Neverwinter Nights
48           2.  Sound filenames have to be 32 characters long or less.
49     --kotor
50           Create an SSF file fit for use within the game Knights of the Old
51           Republic.  No sound filenames are allowed, only StrRefs.
52     --kotor2
53           Create an SSF file fit for use within the game Knights of the Old
54           Republic II.  No sound filenames are allowed, only StrRefs.
55     input_file
56           The XML file to convert.  If no input file is specified, the XML
57           data is read from stdin.  The encoding of the XML stream must
58           always be UTF-8.
59     output_file
60           The SSF file will be written there.
61

EXAMPLES

63     Convert file1.xml into an SSF for Neverwinter Nights:
64
65           $ xml2ssf --nwn file1.xml file2.ssf
66
67     Convert file1.xml into an SSF for Knights of the Old Republic:
68
69           $ xml2ssf --kotor file1.xml file2.ssf
70

SEE ALSO

72     ssf2xml(1), xml2tlk(1)
73
74     More information about the xoreos project can be found on its website:
75     https://xoreos.org/.
76

AUTHORS

78     This program is part of the xoreos-tools package, which in turn is part
79     of the xoreos project, and was written by the xoreos team.  Please see
80     the AUTHORS file for details.
81
82BSD                             April 21, 2016                             BSD
Impressum