You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Moving logging instructions from PlayFabPartyUnity repo to the PlayFab repo for better centralization.
Adding more clarity to the WSL limitation message in response to a customer question
Copy file name to clipboardexpand all lines: README.md
+33-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,39 @@ Please download, unzip, and copy the corresponding asset folder for your platfor
11
11
* 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).
12
12
* Linux - `/x64/Release/libparty.so`
13
13
14
+
## Logging
15
+
The underlying Party C++ library includes logging capabilities with a configurable verbosity level. Logging configuration is defined in `PlayFabPartyLogger.json` file which can be deployed as an asset along with the application. An example of configuration file:
16
+
17
+
```json
18
+
{
19
+
"enabled": false,
20
+
"bufferSize": 16384,
21
+
"maxNumberOfItemsInBatch": 100,
22
+
"maxBatchWaitTimeInSeconds": 1,
23
+
"readBufferWaitTimeInMilliseconds": 1,
24
+
"logFolder": "/platform-specific-path/",
25
+
"logLevel": "VERBOSE",
26
+
"xrnLogEnabled": false,
27
+
"consoleEnabled": false,
28
+
"maxLogFileSizeInMegabytes": 0
29
+
}
30
+
```
31
+
32
+
When this file is detected by the application in runtime it will use it to enable logging as configured. The following verbosity levels are currently supported:
33
+
1.`VERBOSE` - everything
34
+
2.`INFO` - less than everything, only important messages and errors
35
+
3.`ERROR` - only errors
36
+
37
+
The logging is disabled by default, but can be enabled with "enabled" property set to `true`.
38
+
39
+
Instructions to enable logging for specific platform.
40
+
Platform|Where to put PlayFabPartyLogger.json (permission needed)|`logFolder` value|How to view logs
41
+
|-|-|-|-|
42
+
Linux|Create a folder "/home/{user}/PlayFabParty/" where {user} is the current user logged in | /home/{user}/PlayFabParty/log/ | Navigate to the `/home/{user}/PlayFabParty/log/` directory and open logs directly
43
+
iOS|Inside the application folder (Set UIFileSharingEnabled to true in the Info.plist of the app)|/app_sandbox_storage/Documents/|Copy logs from `logFolder` to PC
44
+
Android|Create a folder "\sdcard\PlayFabParty\config" (External storage folder requires READ_EXTERNAL_STORAGE permission)|/sdcard/PlayFabParty/log/|Copy logs from `logFolder` to PC and open in NotePad++
45
+
macOS|~/Documents (Set UIFileSharingEnabled to true in the Info.plist of the app)|~/Documents|Open logs directly in `logFolder`
14
46
15
47
## WSL Compatibility
16
48
17
-
PlayFab Party for Linux is not intended to run on the Windows Subsystem for Linux (WSL). Please run on a dedicated Linux machine to take advantage of all Party features.
49
+
PlayFab Party for Linux is not intended to run on the Windows Subsystem for Linux (WSL) as it does not have built in support for system sound. As a result, chat features will not function properly. Please run on a dedicated Linux machine to take advantage of all Party features.
0 commit comments