Version
menu_open
Wwise SDK 2023.1.4
Source Control Plug-in Sample Code

Basic Source Control Sample Plug-in

This source control plug-in demonstrates a simple configuration dialog with basic operations. It displays the file status as well as the Project Explorer icons. Note that it is not based on any actual source control system, it is just meant to be used as a base project to understand how source control plug-ins work in Wwise, and to start building your own plug-in.

Location: "samples\SourceControl\SourceControlSample"

The source code of the DLL interface that implements the exported functions and the definition file that contains the functions to be exported can be found at:

  • SourceControlSample/DllInterface.cpp
  • SourceControlSample/SourceControlSample.def

The AK::Wwise::ISourceControl implementation can be found at:

  • SourceControlSample/SamplePlugin.cpp
  • SourceControlSample/SamplePlugin.h

The configuration dialog implementation can be found at:

  • SourceControlSample/DlgConfiguration.cpp
  • SourceControlSample/DlgConfiguration.h

Perforce Source Control Sample Plug-in

This is the Perforce plug-in that is included with Wwise by default. It lets you perform Perforce operations from within the Wwise authoring application. Full source code is included, to give you a complete example of a source control plug-in, and to allow you to customize and enhance the plug-in if you want to.

Location: SDK/samples/SourceControl/Perforce

How to build the Perforce Source Control Sample Plug-in

Before you can build the Perforce plug-in for Wwise, you will need to install the Perforce C++ API and OpenSSL files, and place them at the correct location:

  1. Download the Helix Core C/C++ API for Windows (x64) libraries from the Perforce FTP. The version used to build the plug-in included with Wwise is p4api_vs2019_static_openssl3.zip (version 2023.1/2468153).
  2. Create the following directory: "[Wwise Installation Root]/Authoring/source/3rdParty/Perforce/windows"
  3. Extract the content of p4api-<version>-<configuration>/lib to: [Wwise Installation Root]/Authoring/source/3rdParty/Perforce/windows/lib
  4. Extract the content of p4api-<version>-<configuration>/include to: [Wwise Installation Root]/Authoring/source/3rdParty/Perforce/windows/include
Note: The Helix C/C++ API archive contains only release libraries. For this reason, a debug build of the plug-in uses the release CRT library and (DEBUG, _DEBUG) are not defined.
  1. Download the OpenSSL 3.1.1 binaries and libraries Windows (x64) from https://download.firedaemon.com/FireDaemon-OpenSSL/openssl-3.1.1.zip. Current version is OpenSSL 3.1.1 (git commit openssl-3.1.1-0-g2cf4e90eaa).
  2. Extract the binaries (libcrypto-3-x64.dll, libssl-3-x64.dll) to: [Wwise Installation Root]\Authoring\source\3rdParty\OpenSSL\bin
  3. Extract the libraries (libcrypto.lib, libssl.lib) to: [Wwise Installation Root]\Authoring\source\3rdParty\OpenSSL\lib

You should now be able to open the Perforce plug-in's project (SDK/samples/SourceControl/Perforce/Perforce.vcxproj) and build the plug-in. Refer to Source Control Plug-ins for information on the Wwise source control plug-ins API and installation.

Note: Some modifications to the code or project may be required in order to build with a different version of Perforce.

Subversion Source Control Sample Plug-in

This is the Subversion plug-in that is included with Wwise by default. It lets you perform Subversion operations from within the Wwise authoring application. Full source code is included to give you a complete example of a source control plug-in. By including the source code, you can customize and enhance the plug-in if you want to.

Location: SDK/samples/SourceControl/Subversion

How to build the Subversion Source Control Sample Plug-in

Open the Subversion plug-in's project (SDK/samples/SourceControl/Subversion/Subversion.vcxproj) and build the plug-in. Refer to Source Control Plug-ins for information on the Wwise source control plug-ins API and installation.

Note: The Subversion plug-in that is included in the Wwise distribution was built using Subversion 1.8.5. Some modifications to the code or project may be required in order to build with a different version of Subversion.
Note: The Debug configuration of the Subversion plug-in uses the non-Debug Runtime Library to avoid memory allocation problems between the Subversion libraries and the plug-in.

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