Unity Plugin for Windows 8.1 and Windows Phone 8.1 used to support implementations of Windows or Windows Phone platform specific functionality missing within Unity.

See the Unity FAQ on Universal Apps which contains a complete breakdown of the platform conditional compilation you can use with Windows Apps and also broad guidance around the special plugin folders on Windows apps.

CI

Release

• Visual Studio 2013
• Nuget Package Manager
• Unity 5.0.0p2 (tested only on this version but should work on other 5.x builds)

We recommend using the latest stable tagged release, or you can build straight off the head if you are brave.

Configure the solution to Release | Any CPU and Rebuild.

You can then copy the folder contents as follows:

• /MarkerMetro.Unity.WinIntegrationMetro/bin/Release > /Assets/Plugins/Metro/
• /MarkerMetro.Unity.WinIntegrationWP81/bin/Release > /Assets/Plugins/Metro/WindowsPhone81
• /MarkerMetro.Unity.WinIntegrationUnity/bin/Release > /Assets/Plugins/

Alternatively, you can download latest from Nuget

Extract the files from the package and copy the folder contents as follows:

• /lib/netcore45/ > /Assets/Plugins/Metro/
• /lib/wpa81 > /Assets/Plugins/Metro/WindowsPhone81
• /lib/net35 > /Assets/Plugins/

Within your Windows application, just need to ensure you initialize the plugin appropriately with examples as follows:

For Windows Universal and Windows 8.1 Apps add the following method to App.xaml.cs and call it after the call to appCallbacks.InitializeD3DXAML().

public void InvokeOnAppThread(Action callback)
{
    appCallbacks.InvokeOnAppThread(() => callback(), false);
}

public void InvokeOnUIThread(Action callback)
{
    appCallbacks.InvokeOnUIThread(() => callback(), false);
}

You can see existing implementations in WinShared here:

• Windows Universal

You can easily debug a particular Windows Store or Windows Phone plugin project as follows:

1. Add the platform specific WinIntegration project to your solution (e.g. MarkerMetro.Unity.WinIntegrationMetro)
2. Build platform specific WinIntegration project in Debug and copy output to Unity(e.g. /Assets/Plugins/Metro)
3. Build from Unity
4. Set breakpoints in your platform specific WinIntegration plugin project and then F5 on your app

This plugin helps with a number of missing pieces of missing functionality within Unity. Use the Unity APIs if you can, and use WinIntegration where they are missing functionality.

Wherever possible you want to minimize the changes to existing code, therefore we recommend applying a using statement for the platforms you need to provide support for.

We recommend you look at WinShared which uses WinIntegration to demonstrate capabilities.

There is no Unity Plugin for Windows at this time. We have filled the gap by providing the most used functionality from the Unity SDK for Facebook in WinIntegration.

Windows Phone 8.1 supports uses a native mobile internet explorer approach. For login, this provides a long lived SSO token which is checked and refreshed at most every 24 hours. This eliminates any problems with tokens or cookies expiring, so app request dialogs (also displayed in mobile IE) and graph calls will work without issues.

Modify the app's manifest to add a protocal handler to ensure the native mobile IE facebook integration can work.

• Windows Phone 8.1

You also need to assign a UriMapper

• Windows Phone 8.1 See the OnActivated method.

For Windows Phone 8.1 ensure you add the Internet capability to the app's manifest.

Windows 8.1 uses a traditional web view approach which we will be looking to ugprade to in the future release if and when possible.

You will need to ensure you have assigned the Internet capability.

Add a web view control to your app to handle the facebook integration. See example here which you can customize to your requirements.

The control can be declared in your app's MainPage.xaml. See example here

Lastly, you need provide an instance of the web view to the plugin so that the facebook integration can work.

FB.SetPlatformInterface(web);

You can see how this is done here:

• Windows 8.1 Universal

We aim to mimic the Unity SDK for Facebook functionality as much as possible with a wrapper/facade class.

For a complete implementation of Facebook Integration using WinIntegration check out our starter template MarkerMetro.Unity.WinShared.

To begin, add using statements to include the Facebook APIs as follows within your Unity script.

#if UNITY_WINRT && !UNITY_EDITOR
using MarkerMetro.Unity.WinIntegration.Facebook;

#if (UNITY_WP8 || UNITY_WP_8_1) && !UNITY_EDITOR
using FBWin = MarkerMetro.Unity.WinIntegration.Facebook.FBNative;
#else
using FBWin = MarkerMetro.Unity.WinIntegration.Facebook.FB;
#endif

#endif

Facebook implementations are quite game specific, however you will always need to initialize the FB client with your App ID.

Here's an example of the basic init call:

FBWin.Init(fbInitComplete, "[api key]", fbOnHideUnity); 

private void fbInitComplete()
{
    // handler for Unity to deal with FB initialization complete
}

private void fbOnHideUnity(bool isShow)
{
    // handler for UNity to deal with FB web browser visibility changes (only applies to Win 8.1)
}

Note: a redirect url may need to be explicitly passed in if the default FB.Init call does not work and you get "Given URL is not allowed by the Application configuration". In this case, the you will need to provide a valid redirectUrl via their facebook app page. This is at > Settings > Advanced > Valid OAuth redirect URIs within Facebook App. This value should NOT be a local address (e.g .http://localhost...) as that causes problems on Windows 8.1. It doesn't really matter what it is, just that it's a valid url.

A callback approach is used for login:

FBWin.Login("publish_actions", fbResult =>
{
    // Successful login, or deal with errors
});

A callback approach is used for app request dialogs:

FBWin.AppRequest(
                string message,
                string[] to = null,
                string filters = "",
                string[] excludeIds = null,
                int? maxRecipients = null,
                string data = "",
                string title = "",
                fbResult =>
{
    // Successful app request with friends json, or deal with errors
});

For Windows 8.1, note that only the message and callback are supported at this time. For Windows Phone message, to, data and title parameters are supported. The other parameters are included to provide API parity with the Unity Facebook SDK, but are not functional at this time.

A callback approach is used for feed dialog requests:

FBWin.Feed(
            string toId = "",
            string link = "",
            string linkName = "",
            string linkCaption = "",
            string linkDescription = "",
            string picture = "",
            string mediaSource = "",
            string actionName = "",
            string actionLink = "",
            string reference = "",
            Dictionary<string, string[]> properties = null,
                fbResult =>
{
    // Successful feed request, or deal with errors
});

For both Windows 8.1 and Windows Phone, note that only the toId, link, linkName, linkDescription and picture parameters are supported at this time, for Windows Phone message, to, data and title parameters are supported. The other parameters are included to provide API parity with the Unity Facebook sdk, but are not functional.

Note that on Windows Phone the app actually deactivates and resumes as it hands off to mobile IE for all facebook integration, however the callback will still fire on resume.

Lastly note, the FB.cs and FBNative.cs classes in WinIntegration are very similar and we are working on aligning more closely. It is expected that FB.cs will be fully deprecated after Windows 8.1 native mobile IE facebook integration is working.

There is a single Store API for both Windows 8.1 and Windows Phone 8.1.

For a complete implementation of IAP Integration using WinIntegration check out our starter template MarkerMetro.Unity.WinShared

Add an iapsimulator.xml file to the root of your project. This will be used when the store manager is in simulator mode. (https://github.com/MarkerMetro/MarkerMetro.Unity.WinShared/blob/master/WindowsSolutionUniversal/UnityProject/UnityProject.Shared/iap_simulator.xml)

Then ensure you have initialized the store with the following code

            //Initialise Store system
#if QA || DEBUG
            StoreManager.Instance.Initialise(true);
#else
            StoreManager.Instance.Initialise(false);
#endif

For Windows Universal place it in the InitializeUnity method within App.xaml.cs just before the call to construct MainPage.

Note the practice of using a conditional compilation symbol so that you can have IAP simulator or real store api interaction depending on which build you are delivering.

To begin, add a using statement to include the Store APIs.

using MarkerMetro.Unity.WinIntegration.Store;

Determine whether the app has a currently active trial:

bool StoreManager.Instance.IsActiveTrial

Attempt to purchase the application. The Receipt object returned in the delegate will have a StatusCode of Success or ExceptionThrown if anything went wrong.

void StoreManager.Instance.PurchaseApplication(PurchaseDelegate callback)

Attempt to list all IAP products available. This will be a list of products or null if anything went wrong.

void StoreManager.Instance.RetrieveProducts(ProductListDelegate callback)

Attempt to purchase an IAP product. The receipt object returned in the delegate will have a StatusCode of Success or ExceptionThrow if something went badly wrong.

void StoreManager.Instance.PurchaseProduct(PurchaseDelegate callback)

WinIntegration provides an abstraction for exception logging. This is enabled via MarkerMetro.Unity.WinIntegration.Logging.ExceptionLogger.

For a complete implementation of Exception Logging using WinIntegration and the popular crash reporting service Raygun.IO check out our starter template MarkerMetro.Unity.WinShared

You should ensure that exceptions and crashes are reported at both the Unity level and at the app level.

Here is a sample method which should be called when Unity is loaded to ensure the logger is wired up for all Unity exceptions and errors:

/// <summary>
/// Allows for handling of all unity exceptions
/// </summary>
static void InitExceptionLogger()
{
    Application.LogCallback handleException = (message, stackTrace, type) =>
    {
        if (type == LogType.Exception || type == LogType.Error)
        {
            if (WinIntegration.Logging.ExceptionLogger.IsEnabled)
            {
                MarkerMetro.Unity.WinIntegration.Logging.ExceptionLogger.Send(message, stackTrace);
            }
        }
    };
    Application.RegisterLogCallback(handleException);
}

You can see an example of Unity Logging in WinShared.

Create a method as follows and then call it from the bottom of the constructor in App.xaml.cs.

void InitializeExceptionLogger()
{
    // swap RaygunExceptionLogger out with an IExceptionLogger implementation as required
    ExceptionLogger.Initialize(new RaygunExceptionLogger("API KEY"));
}

You can see an Example of Raygun Exception Logger in WinShared. You will need to implement IExceptionLogger for any other crash reporting solution and make sure your app projects have a reference to the required libraries.

You can see a full example of App Unhandled Exception Logging in WinShared using Raygun:

• Windows Universal

To disable exception logging you should comment out any code that initializes the exception logger.

If you are using WinShared, exception logging is configured via AppConfig.cs, specifically the ExceptionLoggingAllowed and ExceptionLoggingBuildConfigs properties.

Local Notifications can be set using LocalNotifications.ReminderManager.

The ReminderManager will use system reminders on WP8, and scheduled notification toasts on Win8.1 allowing you to set deterministic timer based prompts easily for the user. See example here

You should ensure that you add IsToastCapable = true within your manifest on Windows 8.1 and Windows Phone 8.1

• Win 8.1 Ensure that you have enabled "Is Toast Capable" in your manifest
• Add an option in settings screen to disable reminders
• Win 8.1 Add toggle in settings charm to disable reminders

This allows you to play a video over the top of the Unity scene. It will use a standard XAML MediaElement and

        string path = Application.streamingAssetsPath + "/MarkerMetro/ExampleVideo.mp4";
        VideoPlayer.PlayVideo(path, () =>
        {
            Debug.Log("Video Stopped.");
        }, VideoStretch.Uniform);

A full example is provided as part of (MarkerMetro.Unity.WinShared](https://github.com/MarkerMetro/MarkerMetro.Unity.WinShared/blob/master/Assets/MarkerMetro/Example/Scripts/GameMaster.cs)

Add a using statement to include the APIs.

using MarkerMetro.Unity.WinIntegration;

This class will help with various things such as gettign app version, the device id, store url and determining whether the device is low end. See code documentation for more details

https://github.com/MarkerMetro/MarkerMetro.Unity.WinIntegration/blob/master/SharedSource/Helper.cs

If you are starting a new port and/or you want the best ongoing Unity integration with WinLegacy and related plugins, consider MarkerMetro.Unity.WinShared.

This will provide features such as:

• Initialization included within Windows projects provided
• Test scene demonstrating end to end all the WinIntegration features above, including Facebook and IAP integration.
• Unity menu integration allowing you to get the latest stable version automatically from Nuget
• Unity menu integration for using local solution with automatic copy of build output into correct Unity plugin folders

We're open source, so please help everyone out by contributing as much as you can.