Table of Contents

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 Perforce/Helix Core C/C++ API Windows(x64) vs2013/static libraries from http://www.perforce.com/ or ftp://ftp.perforce.com/perforce. Current version is Perforce 2018.1 C/C++ API.
  2. Extract the release library to: "[Wwise Installation Root]\Authoring\source\3rdParty\Perforce\vs2015\Release"
  3. Extract the debug library to: "[Wwise Installation Root]\Authoring\source\3rdParty\Perforce\vs2015\Debug"
  4. After the extraction, the Release and Debug folder should have the "include", "lib" and "sample" directories
  1. Download the OpenSSL binaries and libraries Windows(x64) from https://indy.fulgan.com/SSL/ and https://indy.fulgan.com/SSL/LinkLibs/. Current version is OpenSSL 1.0.2m.
  2. Extract the binaries (libeay32.dll,ssleay32.dll) to: "[Wwise Installation Root]\Authoring\source\3rdParty\OpenSSL\bin"
  3. Extract the libraries (libeay32.lib,ssleay32.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.gif
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.gif
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.gif
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.