Skip to content

Commit 406a5fa

Browse files
author
Paul Gilmore
committed
Merge pull request #9 from PlayFab/readmeUpdate
readme file updates
2 parents fec6458 + b65a999 commit 406a5fa

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

README.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To connect to the PlayFab service, your machine must be running TLS v1.2 or bett
1717

1818
3. Source Code & Key Repository Components:
1919
----
20-
This package contains three different versions of the PlayFab SDK.
20+
This package contains three different versions of the PlayFab SDK.
2121
* PlayFabClientSDK - This version contains only client libraries and is designed for integration with your game client
2222
* PlayFabServerSDK - Contains server and admin APIs designed to be called from your custom logic server or build process
2323
* PlayFabSDK - Contains all APIs in one SDK.
@@ -26,15 +26,41 @@ This package contains three different versions of the PlayFab SDK.
2626
4. Installation & Configuration Instructions:
2727
----
2828

29-
Coming soon!
29+
The playfab API source code is located within:
3030

31+
{JavaSDK-Location}/PlayFabSDK/src/playfab
32+
33+
The playfab API relies on the Google gson library, located within:
34+
35+
{JavaSDK-Location}/PlayFabSDK/src/com
36+
37+
To create a new project using PlayFab, copy the indicated playfab and com directories into the source directory for your project.
38+
39+
40+
4b. Using the example project:
41+
----
42+
43+
The PlayFabApiTest example project can be run from the console. These instructions assume Windows operating system.
44+
45+
* Extract the JavaSDK Sdk to your computer (referenced as {JavaSDK-Location} within this document)
46+
* Navigate to: {JavaSDK-Location}/PlayFabSDK/src
47+
* Open {JavaSDK-Location}/PlayFabSDK/src/RunPfTests.bat in a text editor such as Notepad++ or FlashDevelop (Regular notepad may not load unix line endings properly)
48+
* Update the path for your testTitleData.json file:
49+
* java -DtestTitleData=C:\depot\pf-main\tools\SDKBuildScripts\testTitleData.json ... etc
50+
* You will need to create a new testTitleData.json file, and change the above path to match your new file (see next section for details)
51+
* Executing RunPfTests.bat should compile the example project, execute the project, make a handful of API calls, and exit
52+
* This uses the standard JUnit testing suite
53+
* The exit code for the example will be 0 for success, or non-zero for failure
54+
* Detailed info about test failures will be in the console output (stdout)
55+
56+
3157
5. Troubleshooting:
3258
----
3359
For a complete list of available APIs, check out the [online documentation](http://api.playfab.com/Documentation/).
3460

3561
#### Contact Us
36-
We love to hear from our developer community!
37-
Do you have ideas on how we can make our products and services better?
62+
We love to hear from our developer community!
63+
Do you have ideas on how we can make our products and services better?
3864

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

@@ -43,7 +69,7 @@ Our Developer Success Team can assist with answering any questions as well as pr
4369

4470
6. Copyright and Licensing Information:
4571
----
46-
Apache License --
72+
Apache License --
4773
Version 2.0, January 2004
4874
http://www.apache.org/licenses/
4975

0 commit comments

Comments
 (0)