Wwise Help

-generate

Launches the file package generation process. You can combine this argument with the File Packager project path or with the -info argument. Here are some examples:

-info {filename}

Specifies the location of the SoundbanksInfo.xml file.

Use with one or multiple 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 in which to save the generated file package.

You can use this argument when the {projectpath} is not specified. It can be either a full file path or the package name. Both options require the inclusion of the file package extension.

You can combine this argument with -output_stm or -output_bnk to generate more than one package file, where each contains a different set of files.

If you explicitly define the -output argument, it takes precedence over the value specified in the project.

-output_stm {filename}

Generates one file package that includes only streamed media files. {filename} specifies the package name and location in which to save the generated file package.

You can use this argument when the {projectpath} is not specified. It can be either a full file path or the package name. Both options require the inclusion of the file package extension.

You can combine this argument with -output or -output_bnk to generate more than one package file, where each 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 in which to save the generated file package.

You can use this argument when the {projectpath} is not specified. It can be either a full file path or the package name. Both options require the inclusion of the file package extension.

You can combine this argument with -output or -output_stm to generate more than one package file, where each contains a different set of files.

-output_loose {directory}

-output_loose

Generates one or multiple file packages that include only loose media files. These files are referenced by Events or structures in at least one SoundBank, but are not included in any SoundBank in the project. {directory} is optional and specifies the location in which to save the generated file packages. If {directory} is not specified, the packages are generated in the same directory that contains the SoundbanksInfo.xml file.

You can use this argument when the {projectpath} is not specified. It can be either a relative or absolute directory.

You can combine this argument with -output, -output_stm, or -output_bnk to generate more than one package file, where each contains a different set of files.

-blocksize {number}

The number of bytes upon which the data within your package is aligned. The number depends on the requirements of the platform and your project's I/O hook.

If not specified, a value of 1 is used, which indicates no alignment.

-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 contains 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 in which the generated SoundBanks were saved by Wwise.

This argument is optional.

-cache_dir {directory}

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

This is normally written as projectpath\.cache\platform\

This argument is optional.

-languages "{language1} {languageN}"

Space-separated list that specifies the languages to package. Use double quotation marks to enclose the list in a single argument.

Use the keyword "SFX" in the language list to package SFX files 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}"

Space-separated list that specifies the SoundBanks to package. Do not include the .bnk extensions. Use double quotation marks to enclose the list in a single argument.

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

You can use this argument when the File Packager project is specified: it automatically builds the packages that have references to the specified SoundBanks.

-includedFilesInBanks "{soundbank1} {soundbankN}"

Space-separated list of SoundBanks that include media files that you want to package as loose media. Do not include the .bnk extensions. Use double quotation marks to enclose the list in a single argument.

You can use this option if the PrepareEvent API needs loose media, and banks loaded in memory also need the same media.

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

-excludedFilesInBanks "{soundbank1} {soundbankN}"

Space-separated list of SoundBanks that include references to media files that you want to package as loose files. Do not include the .bnk extensions. Use double quotation marks to enclose the list in a single argument.

You can use this options if the PrepareEvent API needs loose media, and different SoundBanks loaded in memory also need the same media.

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

-verbosity {level}

Specifies how much information is printed in the tool's standard output and error streams.

Set the level to 0 (errors only), 1 (errors and warnings), or 2 (errors, warnings, and information messages).

	Note
	Printing messages can slow down the packaging process on large projects. If the tool runs slowly, reduce the verbosity level to improve performance.

This argument is optional. By default, all message types are printed (level 2).