Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update XPlatCppSDK Consumption Docs #49

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+26 −0
Open

Update XPlatCppSDK Consumption Docs #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Collaborator

@ScottMunroMS ScottMunroMS Jul 19, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section could be simplified/clarified to just a single warning block

> :warning: - **Pre-built binaries of PlayFabXPlatCppSDK included in release packages are intended only for use in the PartySamples**. These binaries are not intended for production consumption and you should instead build the XPlatCppSDK from source in your project.
>
> On android, this includes the `libparty-android-release/<arch>/lib/libcppsdk.a`
>
> On iOS, this includes `PlayFabParty.framework-for-iOS-Release/PlayFabParty.framework-for-iOS-<arch>-Release/libplayfabxplatcppsdk.a`


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-<arch>-Release/libplayfabxplatcppsdk.a
```

* Android:
```
libparty-android-release/<arch>/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).