discord-rich-presence-plex/README.md

# Discord Rich Presence for Plex

A Python script that displays your [Plex](https://www.plex.tv) status on [Discord](https://discord.com) using [Rich Presence](https://discord.com/developers/docs/rich-presence/how-to).

## Getting Started

1. Install [Python 3.10](https://www.python.org/downloads/)
2. [Download](archive/refs/heads/master.zip) the ZIP file containing the files in this repository
3. Extract the contents of the above ZIP file into a new directory
4. Navigate a command-line interface (cmd.exe, PowerShell, bash, etc.) to the above directory
5. Install the required Python modules by running `python -m pip install -r requirements.txt`
6. Start the script by running `python main.py`

When the script runs for the first time, a `config.json` file will be created in the working directory and you will be prompted to complete the authentication flow to allow the script to retrieve your username and an access token.

The script must be running on the same machine as your Discord client.

## Configuration - `config.json`

### Reference

* `logging`
  * `debug` - Output more information to the console
* `display`
  * `useRemainingTime` - Display remaining time in your Rich Presence instead of elapsed time
* `users` (list)
  * `username` - Username or e-mail
  * `token` - A [X-Plex-Token](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token)
  * `servers` (list)
    * `name` - Friendly name of the Plex Media Server you wish to connect to.
    * `blacklistedLibraries` (optional list) - Alerts originating from libraries in this list are ignored.
    * `whitelistedLibraries` (optional list) - If set, alerts originating from libraries that are not in this list are ignored.

### Example

```json
{
  "logging": {
    "debug": true
  },
  "display": {
    "useRemainingTime": false
  },
  "users": [
    {
      "username": "bob",
      "token": "HPbrz2NhfLRjU888Rrdt",
      "servers": [
        {
          "name": "Bob's Home Media Server",
        },
        {
          "name": "A Friend's Server",
          "whitelistedLibraries": ["Movies"]
        }
      ]
    }
  ]
}
```

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Credits

* [Discord](https://discord.com)
* [Plex](https://www.plex.tv)
* [plexapi](https://github.com/pkkid/python-plexapi)
* [websocket-client](https://github.com/websocket-client/websocket-client)