## List of samples
There are two sample applications provided.

#### DX_APIUsage
This app is based on the simple DXUT framework (a simple game engine based on DX11).
The aim of this sample application is to demonstrate all functionality present in
GfeSDK. It shows usage using both the C API directly, and the C++ API bindings. This
is done using a "GfeSDKWrapper". This is not part of the GfeSDK, just used as an
abstraction layer so that the main app can use either set of bindings.

All the business logic lives in Main.cpp. The highlights definitions are stored as
JSON data in highlights_config.json. Main.cpp will read this and configure GfeSDK.

#### NV_UWP_MarbleMaze
This is based on a Microsoft UWP sample application. The aim of this sample app is
not to fully demonstrate every GfeSDK API, but just to demonstrate a semi-realistic
game integration.

To save a highlight, drop the marble down a hole, or successfully complete the level.
Once a level is completed, you may view the highlights from that run at any time
from the scoreboard. This demonstrates highlight persistance.

## Build and debug the samples
Both samples provide a .sln file. Each .sln file containts a single project to build,
and works with debug/release and x64/x86 configurations. The WindowsSDK must be
installed in order to build the applications. This is usually installed if Visual
Studio is installed. In addition, the UWP project may prompt you to install certain
Visual Studio UWP components.

## Run the samples without building
Binary versions of the sample applications are provided in samples/bin. These are
both build as x86 release applications, to allow any PC setup to run them.

#### DX_APIUsage
Installation is not necessary for this sample. Just run the .exe

#### NV_UWP_MarbleMaze
UWP applications must be sideloaded in order to run them.
* Ensure you are able to run PowerShell scripts https://stackoverflow.com/a/4038991
* Ensure you are able to sideload .appx files.
  * Windows settings -> Updates and Security -> For Developers -> Sideload Apps
* Ensure you've uninstalled the previous version of the test app, if necessary. This can be accomplished by finding the demo application in the start menu, right clicking, and choosing "Uninstall". Another option is to find the app by opening Powershell and running "Get-AppxPackage". It should be near the bottom of the big list. Find the full app name, and run "Remove-AppxPackage -Package <fullappname>"
  * Install the new app by opening PowerShell, and running the .ps1 script found in the sample package. This will sideload the application. Newer versions of Windows10 are able to right click the PowerShell script from Windows Explorer and run it that way.
* You should now be able to find the sample application in the start menu, or through Cortana, etc.

If installation doesn't work, there are several possible problems
* Haven't enabled sideloading
* A file is open in the app's data direction, such as any logfile or direction here: %LOCALAPPDATA%\Package\<fullappname>