From ca920542682a428f3d6d3f7209ecb1540fa87254 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sahil=20Ashar=20=F0=9F=A4=A0?= Date: Tue, 18 Jul 2023 14:19:20 -0700 Subject: [PATCH] Update XPlatCppSDK Consumption Docs --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index e5c7aa9..8159c76 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,29 @@ Please download, unzip, and copy the corresponding asset folder for your platfor * Android - `/android/bin` * Win32 - The win32 binaries are not included in the zip assets. They are available on download on [nuget](https://www.nuget.org/packages/Microsoft.PlayFab.PlayFabParty.Cpp.Windows). * Linux - `/x64/Release/libparty.so` + +### Using PlayFab Party in Production + +We've included a pre-built binary of the [XPlatCppSDK](https://github.com/PlayFab/XPlatCppSdk) in our Release packages. **These pre-built binaries are intended for use only in the PartySamples.** You can find the binaries at the following locations: + +* iOS: +``` +PlayFabParty.framework-for-iOS-Release/PlayFabParty.framework-for-iOS--Release/libplayfabxplatcppsdk.a +``` + +* Android: +``` +libparty-android-release//lib/libcppsdk.a +``` + +* Win32: + * A pre-built `playfabxplatcppsdk.lib` binary for the XPlatCppSDK for Windows is *not included* in the nuget or in this repo. However, we do include a [`PlayFabXPlatCppSdk.vcxproj` file](win32/PartySample/dll/PlayFabXPlatCppSdk.vcxproj), that will compile and generate a `playfabxplatcppsdk.lib` to help your sample get up and running. + +* Linux: + * *Not Included* + +**DO NOT USE THESE PRE-BUILT BINARIES IN PRODUCTION.** + +These binaries are intended to help demonstrate a sample PlayFab Party application, and are not safe for production consumption. + +Please consume the XPlatCppSDK from [source](https://github.com/PlayFab/XPlatCppSdk). \ No newline at end of file