Table of Contents

Using File Packager Arguments in the Command Line

When generating the package file from the command line, you must use specific arguments to define the characteristics of the package. The following table lists the arguments that can be used within the command line.

[Note] Note

The arguments used in the 2009.2 version of the File Packager and previous versions are compatible with the current version.

Argument

Description

-generate

Launches the file package generation process. This argument can be used in combination with the File Packager project path or with the -info argument. Here are some examples:

  • Generate using a File Packager project:

    -generate <project_path>

  • Generate a single package using a SoundbanksInfo.xml file:

    -generate -info <soundbank_info_filename> -output <package_name>

  • Generate a stream package and a bank package using a SoundbanksInfo.xml file:

    -generate -info <soundbank_info_filename> -output_stm <package_name> -output_bnk <package_name>

-info <filename>

Specifies the location of the SoundbanksInfo.xml file.

Use with one or many of the following:

-output

-put_

-output <filename>

Generates one file package that include both SoundBank files and streamed media files. <filename> specifies the package name and location where the generated file package will be saved.

This argument can be specified when the <projectpath> is not specified. It can either be a full file path or just the package name. Both options require the inclusion of the file package extension.

This argument can be used in combination with -output_stm or -output_bnk to generate more than one package file, where each one contains a different set of files.

Although this value is defined in your project, if the -output argument is explicitly defined, it takes precedence over the value specified in the project.

-output_stm <filename>

Generates one file package that include only streamed media files. <filename> specifies the package name and location where the generated file package will be saved.

This argument can be specified when the <projectpath> is not specified. It can either be a full file path or just the package name. Both options require the inclusion of the file package extension.

This argument can be used in combination with -output or -output_bnk to generate more than one package file, where each one contains a different set of files.

-output_bnk <filename>

Generates one file package that include only SoundBank files. <filename> specifies the package name and location where the generated file package will be saved.

This argument can be specified when the <projectpath> is not specified. It can either be a full file path or just the package name. Both options require the inclusion of the file package extension.

This argument can be used in combination with -output or -output_bnk to generate more than one package file, where each one contains a different set of files.

-output_loose <directory>

-output_loose

Generates one or many file packages that include only loose media files. These are files that are referenced by Events or structures in at least one SoundBank, but where the media is not included in any SoundBank in the project. <directory> is optional and specifies the location where the generated file packages will be saved. If <directory> is not specified, the default directory is used, which is the SoundbanksInfo.xml directory.

This argument can be specified when the <projectpath> is not specified. It can either be a relative or absolute directory.

This argument can be used in combination with -output, -output_stm or -output_bnk to generate more than one package file, where each one contains a different set of files.

-blocksize <number>

The number of bytes upon which the data within your package is aligned. The number you specify will depend on the requirements of the platform I/O device.

The typical value for each platform is 1.

[Note] Note

The default value of 1 means that there is no alignment.

For more information about block size and the constraints of each platform's I/O device, refer to the Streaming > Low-Level I/O section of the SDK documentation.

-hideprogressui <boolean>

Specifies whether the Generating Packages dialog is displayed while the packages are being generated from within Wwise.

If set to true, the progress dialog is not displayed. By default, this argument is set to false.

<projectpath>

Specifies a File Packager project path that points directly to a WFPPROJ file. When used with the -generate argument, other arguments are ignored and the File Packager project is used to generate the packages.

This argument is optional.

-soundbanks_dir <directory>

Overrides the information in the SoundbanksInfo.xml file (at SoundBanksInfo/RootPaths/SourceFilesRoot) that specifies the directory where the generated SoundBanks were saved by Wwise.

This is normally written as follows: 'projectpath\GeneratedSoundBanks\platform\'.

This argument is optional.

-cache_dir <directory>

Overrides the information in the SoundbanksInfo.xml file (at SoundBanksInfo/RootPaths/SourceFilesRoot) that specifies the directory where the converted files were saved by Wwise.

This is normally written as follows: 'projectpath\.cache\platform\'.

This argument is optional.

-languages “<language1> <languageN>“

Specifies the list of languages to package.

[Note] Note

The list is space-separated. Use double-quotes to enclose the list in one single argument.

Use the keyword “SFX“ in the language list to package them as well.

This argument is optional. By default all languages are packaged.

This argument is only used when the File Packager project is not specified.

-banks “<soundbank1> <soundbankN>“

Specifies the list of SoundBanks to package. The names do not include the BNK extension.

[Note] Note

The list is space-separated. Use double-quotes to enclose the list in one single argument.

This argument is optional. By default all SoundBanks are packaged.

This argument can also be used when the File Packager project is specified. It will automatically build the packages that have a reference on the specified SoundBanks.

-includedFilesInBanks “<soundbank1> <soundbankN>“

Specifies a list of SoundBanks, from which the media files included in the bank, should be added as loose files to package. This option is only used if loose media is needed for use with the PrepareEvent API and this media is also needed in a bank loaded into memory. The names do not include the BNK extension.

[Note] Note

The list is space-separated. Use double-quotes to enclose the list in one single argument.

This argument is optional. By default, media files included in SoundBanks are not added as loose files to packages.

-excludedFilesInBanks “<soundbank1> <soundbankN>“

Specifies a list of SoundBanks, from which the media files that are referenced but not included in the bank, should be added as loose files to package. This option can be used if loose media is needed for use with the PrepareEvent API and this media is also needed in a different SoundBank that is loaded into memory. The names do not include the BNK extension.

[Note] Note

The list is space-separated. Use double-quotes to enclose the list in one single argument.

This argument is optional. By default, media files that are referenced but not included in a SoundBank are added to the files package only if they are not referenced in any other SoundBank.