Skip to content

Commit 1b605a7

Browse files
author
pgilmorepf
committed
Readme testTitleData.json update
1 parent 58d7f5b commit 1b605a7

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,36 @@ To connect to the PlayFab service, your machine must be running TLS v1.2 or bett
1414
* [Official Microsoft Documentation](https://msdn.microsoft.com/en-us/library/windows/desktop/aa380516%28v=vs.85%29.aspx)
1515
* [Support for SSL/TLS protocols on Windows](http://blogs.msdn.com/b/kaushal/archive/2011/10/02/support-for-ssl-tls-protocols-on-windows.aspx)
1616

17-
3. Troubleshooting:
17+
18+
3. Example Project: PlayFabApiTest.html & PlayFabApiTest.js:
19+
----
20+
21+
These files are an internal PlayFab testing project, which activates and tests the core functionality of the sdk. They are not part of the sdk. You should delete these two files before integrating the sdk with your project.
22+
23+
They require a testTitleData.json file to exist, which is described below.
24+
25+
26+
4. testTitleData.json file required for example test files.
27+
----
28+
29+
This sdk includes an optional example project that is used by PlayFab to verify sdk features are fully functional. The testTitleData.json file provides your secret title information to the unit-test project, so it can execute tests in your own PlayFab title.
30+
31+
The format is as follows:
32+
33+
{
34+
"titleId": "your Game Title ID, found in the settings/credentials section of your dashboard on the website",
35+
"developerSecretKey": "your PlayFab API Secret Key, found in the settings/credentials section of your dashboard on the website - NEVER SHARE THIS KEY WITH PLAYERS",
36+
"titleCanUpdateSettings": "false", // "true" or "false", based on your Allow Client to Post Player Statistics option, found in the settings/general section of your dashboard on the website
37+
"userName": "testUser", // Arbitrary username, you can change this to any valid username
38+
"userEmail": "your@email.com", // This email address will be bound to the username above
39+
"userPassword": "testPassword", // This must be the correct password for the testUser above (if that user does not exist yet, this will be the new password)
40+
"characterName": "testCharacter" // Arbitrary characterName, you can change this to any valid characterName
41+
}
42+
43+
This file must be created and placed in the root of the sdk (beside PlayFabApiTest.html & PlayFabApiTest.js), and must be named "testTitleData.json"
44+
45+
46+
5. Troubleshooting:
1847
----
1948
For a complete list of available APIs, check out the [online documentation](http://api.playfab.com/Documentation/).
2049

@@ -27,11 +56,10 @@ Our Developer Success Team can assist with answering any questions as well as pr
2756
[Forums, Support and Knowledge Base](https://community.playfab.com/hc/en-us)
2857

2958

30-
4. Copyright and Licensing Information:
59+
6. Copyright and Licensing Information:
3160
----
3261
Apache License --
3362
Version 2.0, January 2004
3463
http://www.apache.org/licenses/
3564

3665
Full details available within the LICENSE file.
37-

0 commit comments

Comments
 (0)