From e340d22fe9cc2df03e173a1b34b7724488ccdf82 Mon Sep 17 00:00:00 2001 From: Phin <59180111+phin05@users.noreply.github.com> Date: Wed, 25 Apr 2018 00:42:55 +0530 Subject: [PATCH] Update README.md --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2a03a90..91f3430 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,30 @@ A Python script that displays your [Plex](https://www.plex.tv) status on [Discor * [plexapi](https://github.com/pkkid/python-plexapi) * The script must be running on the same machine as the Discord client. -## Variables +## Configuration -You will have to change the following variables in `discordRichPresencePlex.py`: +Add your configuration(s) into the `plexConfigs` list on line 24. -* Line 14: `plexServerName` - Name of the Plex Media Server to connect to -* Line 15: `plexUsername` - Username of the account the server is signed in as -* Line 16: `plexPasswordOrToken` - Password or a [X-Plex-Token](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token) associated with the above account -* Line 17: `usingToken` - Set this to `True` if the above is a X-Plex-Token -* Line 18: `listenForUser` - Your username, leave it blank if it's the same as `plexUsername` -* Line 19: `extraLogging` - Set this to `True` if you want the program to output more information +### Example + +```python +plexConfigs = [ + plexConfig(serverName = "ABC", username = "xyz", password = "0tYD4UIC4Tb8X0nt"), + plexConfig(serverName = "DEF", username = "pqr@pqr.pqr", token = "70iU3GZrI54S76Tn", listenForUser = "xyz") +] +``` + +### Valid Parameters + +* `serverName` - Name of the Plex Media Server to connect to +* `username` - Username of the account the server is signed in as +* `password` - Password associated with the above account +* `token` - A [X-Plex-Token](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token) associated with the above account, ignores `password` if set +* `listenForUser` - Your username, defaults to `username` if not set + +### Other Variables + +* Line 15: `extraLogging` - Set this to `True` if you want the program to output more information ## License