Create README.md

This commit is contained in:
Phin 2018-02-15 00:20:41 +05:30
parent 2bd64c1e46
commit 6334ced747

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# Discord Rich Presence for Plex
A Python script to display your [Plex](https://www.plex.tv) status on [Discord](https://discordapp.com) using [Rich Presence](https://discordapp.com/developers/docs/rich-presence/how-to).
## Requirements
* [Python 3.6.4+](https://www.python.org/downloads)
* [plexapi](https://github.com/pkkid/python-plexapi)
* The script must be running on the same machine as the Discord client.
## Variables
You will have to change the following variables in `discordRichPresencePlex.py`:
* Line 82: `plexServerName` - Name of the Plex Media Server to connect to
* Line 83: `plexUsername` - Username of the account the server is signed in as
* Line 84: `plexPasswordOrToken` - Password or a X-Plex-Token associated with the above account
* Line 85: `usingToken` - Set this to `True` if the above is a X-Plex-Token
* Line 86: `listenForUser` - Your username, leave blank if it's the same as `plexUsername`