Version
menu_open

Defining the general settings for your project

In the General tab of the Project Settings dialog, you can carry out the following tasks:

Configuring source control plug-ins

If you are using a source control system to manage your project assets and files, you can select a source control plug-in for your project. If the plug-in is supported in the current version of Wwise, you can also configure the plug-in for your workspace.

Wwise comes with two source control plug-ins: Perforce® and Subversion (deprecated).

For more information on what versions of Perforce and Subversion are supported by Wwise, refer to Supported Perforce/Subversion versions or the Wwise SDK documentation.

[Note]Note

Each source control plug-in will have different requirements for the configuration. Verify the configuration settings with your system administrator.

To define the source control plug-in for your project:

  1. Open the Project Settings dialog by doing one of the following:

    • From the Project menu, select Project Settings.

    • Press Shift+K.

  2. From the Plug-in list of the Source Control group, select the <Source Control> plug-in for your project.

  3. To configure the plug-in, click Config.

    The Source Control Plug-in Configuration dialog opens.

  4. Enter the required information in the fields of the Source Control Plug-in Configuration dialog. If Use Audiokinetic Wave Viewer to diff WAV files is enabled, then Wwise Wave Viewer is used to compare WAV files.

    [Note]Note

    Verify the configuration settings with your system administrator.

  5. Click OK to save your configuration settings and to close the Plug-in Configuration dialog.

  6. Click OK to save your settings and close the Project Settings dialog.

Defining Originals folder settings

The project's Originals folder contains copies of the original audio files that you import into your project. Its location is defined when you create the project. In the General tab, you can specify the location for the Original files. You can also include environment variables as part of the path, for example, $(WWISESDK) or $(TEMP). You can select a location for the entire project, or you can choose to save these files in an alternate location for your own use. This option can be very useful in the following situations:

  • You are working remotely and don't have access to the Originals folder.

  • You do not have permission to alter the contents of the Originals folder.

  • You need to create a temporary location for your Originals folder without changing the location of the project Originals folder.

[Note]Note

If the project-defined Originals folder is not accessible, the override setting will be automatically turned on, and the Originals folder will be moved to your project folder so that you can work in the project.

For more information about the Originals folder, refer to The media file structure.

To define the location of the Originals folder for your project:

  1. Open the Project Settings dialog by doing one of the following:

    • From the Project menu, select Project Settings.

    • Press Shift+K.

  2. To define the Originals file folder location for your project, do one of the following:

    In the Original Audio Files group, type or paste the path of the Original folder. This path can be absolute or relative to the project's folder. The default path is "Originals".

    Click the Browse button (...) to use the Advanced Folder Picker to specify a location where you want to store your Originals audio file folder.

  3. To define the Originals file folder location for your personal use, do one of the following:

    • In the Original Audio Files group, select the Override location for current user option.

    • Click the Browse button (...) to use the Advanced Folder Picker to specify a location where you want to store your Originals audio file folder.

  4. Click OK to save your settings and close the Project Settings dialog.

Defining cache folder settings

The project's cache folder contains intermediate data generated by Wwise during audio file conversion and SoundBank generation. Its location is initially set to '.cache/' inside the project's directory when a new project is created. On the General tab of the Project Settings dialog, you can modify the location for the cache files. You can also include environment variables as part of the path, for example, $(WWISESDK) or $(TEMP). You can select a location for the entire project, or you can choose to save these files in an alternate location for your own use. This option can be useful in the following situations:

  • You are working remotely and don't have access to the cache folder.

  • You do not have permission to alter the contents of the cache folder.

  • You need to create a temporary location for your cache folder without changing the location of the project cache folder.

[Note]Note

If the project-defined cache folder is not accessible, the override setting will automatically be turned on, and the cache folder will be moved to your project folder so that you can work in the project.

If you chose to override the location of the cache folder, the next time you open your Wwise project it will be in the new location. Other users, however, will still access the folder in its original location. Turn off this option to go back to accessing the cache folder at the project location. For more information about the cache folder, refer to The media file structure.

[Caution]Caution

Multiple users should NOT access the same cache folder simultaneously.

To define the location of the cache folder for your project:

  1. Open the Project Settings dialog by doing one of the following:

    • From the Project menu, select Project Settings.

    • Press Shift+K.

  2. To define the cache file folder location for your project, do one of the following:

    • In the Cached Audio Files group, type or paste the path of the cache folder. This path can be absolute or relative to the project's folder. The default path is ".cache".

    • Click the Browse button (...) to use the Advanced Folder Picker to specify a location where you want to store your cache file folder.

  3. To define the cache file folder location for your personal use, do one of the following:

    • In the Cached Audio Files group, select the Override location for current user option.

    • Click the Browse button (...) to use the Advanced Folder Picker to specify a location where you want to store your cache file folder.

  4. Click OK to save your settings and close the Project Settings dialog.

Defining Event creation settings

Events in Wwise can be created in a multitude of ways. If an Event is created without a target object, Wwise will give the new Event a generic name. If however the Event is created for a selected object, you can specify how Wwise constructs the new event's name.

To define the Event Creation Settings for your project:

  1. Open the Project Settings dialog by doing one of the following:

    • From the Project menu, select Project Settings.

    • Press Shift+K.

  2. Select whether to specify the Event Creation Settings for the project or the current user:

    • To set the Event Creation Settings for the project, select Define settings for project.

    • To set the Event Creation Settings for the current user, select Override settings for current user.

  3. Select the desired Event Creation Settings:

    • Enable Add action name to include the Action name in the Event name.

    • Enable Modify case to set the case of the Event name.

    See below for more details.

  4. Click OK to save your settings and close the Project Settings dialog.

By default, the object's name is used as the new Event name. The following options can modify the new Event name:

  • Add action name: if enabled, the event's action name is added to the Event name.

    1. set as prefix - the Action name is used as a prefix to the object name: <action_name>_<object_name>

    2. set as suffix - the Action name is used as a suffix to the object name: <object_name>_<action_name>

  • Modify case: if enabled, the case of the event's name is changed.

    1. all lowercase - the event's name is all lowercase.

    2. all uppercase - the event's name is all uppercase.

[Note]Note

The Event Creation Settings may be configured for the entire project, or for the current user.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise