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: "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 SDK and set an environment variable:

1. Download the Perforce C/C++ API static libraries from http://www.perforce.com/ and extract it to the local folder of your choice.
   • To build the 32-bit plug-in, use the ntx86 Perforce SDK for VS2012 with static libraries
   • To build the 64-bit plug-in, use the ntx64 Perforce SDK for VS2012 with static libraries
   • Note that you will need the debug libs to compile the plug-in in debug.
2. Create an environment variable and set its value to the folder where the Perforce C/C++ API was extracted. This folder should contain "include", "lib" and "sample" directories.
   • For the 32-bit plug-in / Perforce SDK, the environment variable name is PERFORCE_SDK_X86
   • For the 64-bit plug-in / Perforce SDK, the environment variable name is PERFORCE_SDK_X64
3. A sub folder must be created for the Debug / Release versions of the SDK.
   • For the 32-bit Debug plug-in / Perforce SDK, the Perforce C/C++ API static libraries must be located in the folder "$(PERFORCE_SDK_X86)\Debug"
   • For the 64-bit Release plug-in / Perforce SDK, the Perforce C/C++ API static libraries must be located in the folder "$(PERFORCE_SDK_X64)\Release"

You should now be able to open the Perforce plug-in's solution (samples\SourceControl\Perforce\Perforce.sln) 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 Perforce plug-in that is included in the Wwise distribution was built using the Perforce 2015.1 C/C++ API. 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: "samples\SourceControl\Subversion"

How to build the Subversion Source Control Sample Plug-in

Before you can build the Subversion plug-in for Wwise, you will need to install the Subversion SDK and set an environment variable:

1. Create the environment variable SUBVERSION_SDK and set its value to the folder where the Subversion SDK is built. This folder should contain the "include" folder. The remaining folders, "bin" and "lib", should be in the folder "<platform>\<configuration>", where:

• <platform> is either win32 or x64; and
• <configuration> is either debug or release.

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.

You should now be able to open the Subversion plug-in's solution (samples\SourceControl\Subversion\Subversion.sln) 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 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.