Skip to content

Commit

Permalink
Update README.md: Enable Logging on Linux (#40)
Browse files Browse the repository at this point in the history
Update README.md add information to enable logging on linux
  • Loading branch information
SebastianPD authored Feb 28, 2024
1 parent 1d29e38 commit 81395a9
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ The underlying Party C++ library includes logging capabilities with a configurab
"logFolder": "/platform-specific-path/",
"logLevel": "VERBOSE",
"xrnLogEnabled": false,
"consoleEnabled": false,
"maxLogFileSizeInMegabytes": 0
}
```
Expand All @@ -134,12 +135,18 @@ The logging is disabled by default, but can be enabled with "enabled" property s
Instructions to enable logging for specific platform.
Platform|Where to put PlayFabPartyLogger.json (permission needed)|`logFolder` value|How to view logs
|-|-|-|-|
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
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
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++
macOS|~/Documents (Set UIFileSharingEnabled to true in the Info.plist of the app)|~/Documents|Open logs directly in `logFolder`

## WSL Compatibility

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.

## Troubleshooting
###Expired Tokens:

### Expired Tokens:
PlayFab party unity plugin uses the entity token of the logged-in user to access PlayFab services such as creating a network, speech-to-text and text-to-speech.
However this Entity token has a finite expiration time typically 24 hrs after which the Party Unity plugin might experience issues accessing these services.

Expand Down

0 comments on commit 81395a9

Please sign in to comment.