Updated Custom Scripts for PlexPy (markdown)

JonnyWong16
2018-03-10 08:32:02 -08:00
parent 21eaee7da0
commit fd271475e8

@@ -1,59 +1 @@
### How to Use Custom Scripts
1. Set a "Script Folder" at Settings > Notification Agents > Scripts > Gear Icon. Place any script files in this directory with appropriate permissions (executable and accessible to the PlexPy user).
2. Select the scripts for the actions where you want the script to be triggered (e.g. Playback Start, Playback Stop).
3. Make sure the corresponding action triggers are also enabled under Settings > Notification Agents > Scripts > Bell Icon.
4. Under Settings > Notifications > Scripts, set the arguments that should be passed to the script (e.g. `-si {session_id} -u {user}`)
### List of User Created Scripts
#### PlexPy Scripts:
| Description | Language | Author |
| --- | --- | --- |
| [Kill a transcode](https://gist.github.com/Hellowlol/ee47b6534410b1880e19) | Python | [Hellowlol](https://gist.github.com/Hellowlol) |
| [Throttle nzb client](https://gist.github.com/Hellowlol/a5d0cab4bde185b38404) | Python | [Hellowlol](https://gist.github.com/Hellowlol) |
| [Send an Email notification when a specific show is added to Plex](https://gist.github.com/JonnyWong16/2fbd4aeff11bc2452db3) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Send an Email notification to specific users when a show is added to Plex](https://github.com/blacktwin/JBOPS/blob/master/notify/notify_on_added.py) | Python | [blacktwin](https://github.com/blacktwin) |
| [Send an Email notification to users when a new episode to their "favorite" show have been added to Plex](https://github.com/blacktwin/JBOPS/blob/master/notify/notify_user_favorites.py) | Python | [blacktwin](https://gist.github.com/blacktwin) |
| [Send an IFTTT notification for a specific username](https://gist.github.com/JonnyWong16/6d3314287569f5a83422f6a8e30d61fd) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Send a PlexPy notification when the total number of streams exceeds a threshold](https://gist.github.com/JonnyWong16/1b1b02536e25002daf678946f513b950) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Send a PlexPy notification with the movie directors' IMDB page](https://gist.github.com/JonnyWong16/d508d8d5d1fcb336efc1a3d167eb7b1a) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Send a random Chuck Norris joke when a movie starring Chuck Norris is played](https://gist.github.com/JonnyWong16/6e3b07bbc99eeb15183ba86be5bdf9a7) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Send a PlexPy notification with geolocation data](https://gist.github.com/JonnyWong16/48d6362884b5edbf5e6d78859035183a) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Get notified when Plex disk usage exceeds a certain threshold](https://gist.github.com/JonnyWong16/f561f06a6266db66dad9) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Get notified on Telegram when a user is transcoding](https://gist.github.com/JonnyWong16/3591d1fee289daaafeb8) | Python | [pmow](https://gist.github.com/pmow)/[Hellowlol](https://gist.github.com/Hellowlol) |
| [Get notified on Telegram when a user is transcoding](https://gist.github.com/JonnyWong16/e4919c24b8884026ec6d) | Bash | [pmow](https://gist.github.com/pmow) |
| [Delete PlexPy history older than "X" days](https://gist.github.com/JonnyWong16/cb1b53e71b89d2159313) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Restart Plex](https://gist.github.com/Hellowlol/daaa7aa4c5f8bd54033895df5a5fb2d2) | bat | [Hellowlol](https://gist.github.com/Hellowlol) |
| [Plex Docker Container Restart with Rancher](https://gist.github.com/JigSawFr/70d7f95f16f1f6f27528a18e183ee67c) | Bash | [JigSawFr](https://gist.github.com/JigSawFr) |
| [PlexPy - Quiet hours and smart batching for Pushbullet notifications](https://gist.github.com/JimboMonkey1234/1c27897c3204c6b72a05fea64f0a9f02) | Python | [JimboMonkey1234](https://gist.github.com/JimboMonkey1234) |
| [Generate map from user geolocation data](https://github.com/blacktwin/JBOPS/tree/master/maps) | Python | [blacktwin](https://gist.github.com/blacktwin) |
| [Get notified when new IP address accesses Plex](https://github.com/blacktwin/JBOPS/blob/master/notify/notify_newip.py) | Python | [blacktwin](https://gist.github.com/blacktwin) |
| [Kill transcode stream if paused](https://github.com/blacktwin/JBOPS/blob/master/killstream/kill_trans_pause.py) | Python | [blacktwin](https://gist.github.com/blacktwin) |
| [Run a SSH command using Python](https://gist.github.com/JonnyWong16/e140f546b09950829685f000b7cf98bc) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Kill Plex video transcoding streams only. All audio streams are left alone.](https://github.com/blacktwin/JBOPS/blob/master/killstream/kill_trans_exp_audio.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Kill stream if user is outside of local network.](https://github.com/blacktwin/JBOPS/blob/master/killstream/kill_outsider_stream.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Kill transcode if paused for more than X time.](https://github.com/blacktwin/JBOPS/blob/master/killstream/create_wait_kill_all.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Send an email with what was added to Plex in the past week.](https://github.com/blacktwin/JBOPS/blob/master/notify/notify_added_custom.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Automatically add a label to recently added items](https://gist.github.com/JonnyWong16/4cfcf8ea50dab1b720b4d30e9a01835c) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Updates all metadata in the PlexPy database after moving Plex libraries](https://gist.github.com/JonnyWong16/f554f407832076919dc6864a78432db2) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Send recently added through native iOS push (OneSignal)](https://gist.github.com/LuisNunezC/64a3e677887c8ffb76e0f0de1c43311b) | Python | [LuisNunezC](https://github.com/LuisNunezC) |
#### Other Plex Scripts:
| Description | Language | Author |
| --- | --- | --- |
| [Automatically share and unshare libraries for Plex users](https://gist.github.com/JonnyWong16/f8139216e2748cb367558070c1448636) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Execute a command when no Plex sessions are active](https://gist.github.com/JonnyWong16/bc50c882985cc495e629f41c12bc7590) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Create a Plex collection from a text file list of rating keys](https://gist.github.com/JonnyWong16/148b5a5dc39211bd6a871cb8f9df8c48) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Sync Plex playlists to shared users](https://gist.github.com/JonnyWong16/2607abf0e3431b6f133861bbe1bb694e) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Removes ALL collections from ALL movies](https://gist.github.com/JonnyWong16/34878448ab45dfffffa930f5cf8c252a) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Saves artist.jpg to the Artist folder.](https://gist.github.com/JonnyWong16/8ede4aabce105217a70cc2386ce673f7) | Python | [JonnyWong16](https://gist.github.com/JonnyWong16) |
| [Randomly create haiku based on Plex libraries content.](https://github.com/blacktwin/JBOPS/blob/master/fun/plexapi_haiku.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Create a Plex Playlist with what was aired today in history.](https://github.com/blacktwin/JBOPS/blob/master/fun/aired_today_playlist.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Pull Movie and TV Show poster images from Plex.](https://github.com/blacktwin/JBOPS/blob/master/utility/plex_api_poster_pull.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Download theme songs from Plex TV Shows.](https://github.com/blacktwin/JBOPS/blob/master/utility/plex_theme_songs.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Delete shows that a list of users have watched.](https://github.com/blacktwin/JBOPS/blob/master/utility/delete_watched_TV.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
| [Delete movies that a list of users have watched.](https://github.com/blacktwin/JBOPS/blob/master/utility/remove_watched_movies.py) | Python | [Blacktwin](https://gist.github.com/Blacktwin) |
**The wiki has moved to https://github.com/Tautulli/Tautulli-Wiki/wiki**.