JavaScriptSDK for the Client API of PlayFab
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
PlayFabSdk
PlayFabTestingExample
images/TypeScript
licenses
.gitignore
JavaScriptGettingStarted.md
LICENSE
README.md
TypeScriptGettingStarted.md

README.md

JavaScriptSDK README

1. Overview:

JavaScriptSDK for the Client API of PlayFab

This SDK can alternatively be used via our CDN. Additional details can be found here.

If you want to start coding right away, check out our JavaScript Getting Started Guide

2. Prerequisites:

To connect to the PlayFab service, your machine must be running TLS v1.2 or better.

3. Example Project (UNDER CONSTRUCTION)

The Example project is being revised for the upcoming 1.0 release

This sdk includes an optional example project that is used by PlayFab to verify sdk features are fully functional.

Please read about the testTitleData.json format, and purpose here:

  • testTitleData.md must be created and placed in the root of the example (beside index.html & PlayFabApiTest.ts), and must be named "testTitleData.json"

4. Troubleshooting:

For a complete list of available APIs, check out the online documentation.

Contact Us

We love to hear from our developer community! Do you have ideas on how we can make our products and services better?

Our Developer Success Team can assist with answering any questions as well as process any feedback you have about PlayFab services.

Forums, Support and Knowledge Base

7. NPM support:

You may install JavaScript SDK with npm by running :

npm install playfab-web-sdk

Notice that it will install web JavaScript package as opposed to npm install playfab which will install NodeJS SDK.

While npm is generally used for server side packages, you may use one of popular build tools to mix NPM installed packages into your clientside JS codebase. Consider Babel, Webpack, Gulp or Grunt for different approaches to building and automation.

6. Acknowledgements

dylanh724 - The previous tutorial before the current Getting Started Guide

7. Copyright and Licensing Information:

Apache License -- Version 2.0, January 2004 http://www.apache.org/licenses/

Full details available within the LICENSE file.