Developer Quick Start Guide

[ndaversa]

Information on how to get an environment setup to develop plugins

Hey all,

I'm a developer with c/c++/java/obj-c/etc background. Although I have never touched Python it seems rather friendly.

I know there is really no documentation to go off of, but I wanted to get some getting started info with respect to plug-in development.

I currently have plans to expand the EyeTV Scanner Plug-in (make it more robust, handle Series where applicable and fallback to Movie as a last resort) and perhaps a find videos in RAR archives scanner, so we can use the Plex iOS app to stream stuff even if you haven't extracted the video yet (usecase: downloads wrapped in rars currently being seeded).

I wanted to know a few basics and perhaps consolidate some of the information here so others can get started quickly, so perhaps if anyone has the time they could explain how to do the following (I'm familiar with some of these, but for the sake of completeness):

1. Where to save my .py file so the Plex Media Server picks it up.
2. What libraries to include? (as a boilerplate)
3. Where can I see compiler/syntax errors for my script?
4. Where can I find what commands can be made to the Plex Media Server (easiest way considering there is currently no documentation).

Thanks
ND

[sander1]

Hi ND!

I know there is really no documentation to go off of, but I wanted to get some getting started info with respect to plug-in development.

Although the docs may not be 100% complete and are written for the v1 framework, there's a lot of info to find there already (v2 framework changes are very small, so the docs are still very usable):
http://dev.plexapp.com/docs/
http://wiki.plexapp.com/index.php/Plugin_development

[...]and perhaps a find videos in RAR archives scanner, so we can use the Plex iOS app to stream stuff even if you haven't extracted the video yet (usecase: downloads wrapped in rars currently being seeded).

Before starting on RAR stuff, have a look at this topic: http://forums.plexapp.com/index.php?/topic/17211-transprar-rar-workaround-for-plex-9/

I wanted to know a few basics and perhaps consolidate some of the information here so others can get started quickly, so perhaps if anyone has the time they could explain how to do the following (I'm familiar with some of these, but for the sake of completeness):
1. Where to save my .py file so the Plex Media Server picks it up.

Plugin bundles ([bundle info](http://dev.plexapp.com/docs/Bundle.html)) are saved in *~/Library/Application Support/Plex Media Server/Plug-ins*

2. What libraries to include? (as a boilerplate)

For v1 framework:

from PMS import *

For v2 framework: nothing, this is done automatically

3. Where can I see compiler/syntax errors for my script?

[list=1]
[*]For **v1** framework include this in your Info.plist file:

<key>PlexPluginDebug</key><br />
<string>1</string>

For **v2** framework include this in your Info.plist file:

<key>PlexPluginConsoleLogging</key><br />
<string>1</string>

[*]Then run PMS from Terminal:

/usr/bin/killall Plex\ Media\ Server<br />
<br />
~/Library/Application\ Support/Plex/Plex\ Media\ Server.app/Contents/MacOS/Plex\ Media\ Server woof

or check the Console for plugin output.[/list]

4. Where can I find what commands can be made to the Plex Media Server (easiest way considering there is currently no documentation).

Not sure what you meant with this...?

Tip: have a look at existing plugins ([Github repo](http://github.com/plexinc-plugins)).

[ndaversa]

Thanks for the quick response.



To rephrase the last question…



I have seen some other scanners, eg. EyeTV. I see the calls to Media.Episode() there, wanted to know if that is documented anywhere.



Thanks

ND

Hi ND!


Although the docs may not be 100% complete and are written for the v1 framework, there's a lot of info to find there already (v2 framework changes are very small, so the docs are still very usable):
http://dev.plexapp.com/docs/
http://wiki.plexapp.com/index.php/Plugin_development



Before starting on RAR stuff, have a look at this topic: http://forums.plexapp.com/index.php?/topic/17211-transprar-rar-workaround-for-plex-9/



Plugin bundles ([bundle info](http://dev.plexapp.com/docs/Bundle.html)) are saved in *~/Library/Application Support/Plex Media Server/Plug-ins*



For v1 framework:

from PMS import *

For v2 framework: nothing, this is done automatically



[list=1]
[*]For **v1** framework include this in your Info.plist file:

<key>PlexPluginDebug</key><br />
<string>1</string>

For **v2** framework include this in your Info.plist file:

<key>PlexPluginConsoleLogging</key><br />
<string>1</string>

[*]Then run PMS from Terminal:

/usr/bin/killall Plex\ Media\ Server<br />
<br />
~/Library/Application\ Support/Plex/Plex\ Media\ Server.app/Contents/MacOS/Plex\ Media\ Server woof

or check the Console for plugin output.[/list]


Not sure what you meant with this...?

Tip: have a look at existing plugins ([Github repo](http://github.com/plexinc-plugins)).

[RomanTPA]

i know python basics and want to take a shot at making a plug in.

where could i find some sample code for a plug in for website that streams movies or uses flash?



Thank You

RK

[jwray]

All the existing plugin code is available on github. One repository per plugin:



Plex Plug-ins · GitHub



Jonny

i know python basics and want to take a shot at making a plug in.
where could i find some sample code for a plug in for website that streams movies or uses flash?

Thank You
RK