# How to install a custom scanner

**URL:** <https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960>\
**Category:** Dev/API Corner\
**Tags:** scanner-agent-dev\
**Created:** [October 16, 2010, 10:02pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960 "2010-10-16T22:02:42Z")\
**Posts on this page:** 20\
**Page:** 1

<div class="post-metadata">

**Author:** ![elan](https://sea1.discourse-cdn.com/plex/user_avatar/forums.plex.tv/elan/32/5_2.png) [@elan](https://forums.plex.tv/u/elan)\
**Post date:** [October 16, 2010, 10:02pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/1 "2010-10-16T22:02:42Z")

</div>

Scanners are responsible for getting your media into Plex. This is in contrast to Metadata Agents, which are responsible for getting posters, artwork, descriptions, ratings, etc.  
  
  
  
Custom scanners live inside your Plex Media Server [data directory](https://support.plex.tv/hc/en-us/articles/202915258) in:  
  
  
  
**Windows** :

```auto

%LOCALAPPDATA%\Plex Media Server\Scanners\

```

  
**macOS / OS X** :  

```auto

~/Library/Application Support/Plex Media Server/Scanners/

```

  
Scanners are Python files that live in one of three subdirectories, for movies, music, and TV shows:  
  

```auto

Movies/<br />
Music/<br />
Series/

```

  
By default, neither the "scanners" directory nor the subdirectories will exist, so you'll want to manually create them. Once you install a new scanner by dragging the file into one of these directories, you'll have something like this:  
  

```auto

....Scanners/Music/Plex Music Scanner (no tags).py

```

  
Then restart your Plex Media Server and you'll be able to select the scanner when you create a new library.

---

<div class="post-metadata">

**Author:** ![freesmith](https://avatars.discourse-cdn.com/v4/letter/f/82dd89/32.png) [@freesmith](https://forums.plex.tv/u/freesmith)\
**Post date:** [November 22, 2010, 8:36pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/2 "2010-11-22T20:36:27Z")

</div>

sorry I am kind of new to Plex. I created a scanner but I cannot add it to Plex. Inside this folder I cannot see anything. When I put my scanner inside I do not see it in Plex Manager.  
  
~/Library/Application Support/Plex Media Server/Scanners/  
  
In the other hand I tried to put it also in:  
  
/Users/XXX/Library/Application Support/Plex/Plex Media Server.app/Contents/Resources/Plug-ins/Scanners.bundle/Contents/Resources/Movies/  
  
Music/  
  
Series/  
  
  
  
but nothing happens.do I have to reboot the computer or the server? Before it worked but now I cannot make it work…  
  
thanks

---

<div class="post-metadata">

**Author:** ![elan](https://sea1.discourse-cdn.com/plex/user_avatar/forums.plex.tv/elan/32/5_2.png) [@elan](https://forums.plex.tv/u/elan)\
**Post date:** [November 25, 2010, 10:57am UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/3 "2010-11-25T10:57:22Z")

</div>

Without a more detailed account of exactly what you’re doing (e.g. the file you’re trying to use, and exactly where you’re putting it), it’s hard to tell what’s going wrong. You should be placing the file in ~/Library/Application Support/Plex Media Server/Scanners/, in the appropriate subdirectory, which you may have to create.  
  
  
  
Please post more details and attach the zipped scanner file and we’ll have a look!

---

<div class="post-metadata">

**Author:** ![freesmith](https://avatars.discourse-cdn.com/v4/letter/f/82dd89/32.png) [@freesmith](https://forums.plex.tv/u/freesmith)\
**Post date:** [November 25, 2010, 9:35pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/4 "2010-11-25T21:35:47Z")

</div>

> [@](#):
>
> Without a more detailed account of exactly what you're doing (e.g. the file you're trying to use, and exactly where you're putting it), it's hard to tell what's going wrong. You should be placing the file in ~/Library/Application Support/Plex Media Server/Scanners/, in the appropriate subdirectory, which you may have to create.  
>   
> Please post more details and attach the zipped scanner file and we'll have a look!

  
  
hahaha. key sentence was :"which you may have to create". Now it finally works!thanks for the replies!

---

<div class="post-metadata">

**Author:** ![\_underscore](https://avatars.discourse-cdn.com/v4/letter/_/58956e/32.png) [@\_underscore](https://forums.plex.tv/u/_underscore)\
**Post date:** [December 8, 2010, 10:43pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/5 "2010-12-08T22:43:58Z")

</div>

Is it possible to write a scanner for a content type other than Movies, Music, or Series? Like, “Photos”, or any other arbitrary content type?

> [@](#):
>
> Scanners are Python files that live in one of three subdirectories, for movies, music, and TV shows:  
>   
> 
> ```auto
> 
> <br />
> Movies/<br />
> Music/<br />
> Series/<br />
> 
> ```

---

<div class="post-metadata">

**Author:** ![friedflix](https://avatars.discourse-cdn.com/v4/letter/f/c2a13f/32.png) [@friedflix](https://forums.plex.tv/u/friedflix)\
**Post date:** [February 4, 2011, 2:13am UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/6 "2011-02-04T02:13:37Z")

</div>

Elan,  
  
Can I ask where the TheTVDB scanner that comes built into Plex resides? If I wanted to try to create one for TVRage it would be great for me to be able to see that code…thanks.  
  
  
  
EDIT: Guess i have the terminology wrong…I am guessing i would need to create a different Metadata Agent if i wanted the scanner to work for TVRage…

---

<div class="post-metadata">

**Author:** ![vlitim](https://avatars.discourse-cdn.com/v4/letter/v/50afbb/32.png) [@vlitim](https://forums.plex.tv/u/vlitim)\
**Post date:** [February 19, 2011, 12:35pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/7 "2011-02-19T12:35:19Z")

</div>

How do you get this working one windows? What directory do you need to copy them to?  
  
  
  
cheers

---

<div class="post-metadata">

**Author:** ![MathiasI](https://avatars.discourse-cdn.com/v4/letter/m/5e9695/32.png) [@MathiasI](https://forums.plex.tv/u/MathiasI)\
**Post date:** [March 8, 2011, 4:06pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/8 "2011-03-08T16:06:52Z")

</div>

I can’t get the Windows version of PMS do register new scanners. Has anyone succeeded in using a custom scanner? Pretty sure I’m in the right directory:  
  
C:\Documents and Settings\Administrator\Local Settings\Application Data\Plex Media Server\Plug-ins\Scanners.bundle\Contents\Resources\Movies

---

<div class="post-metadata">

**Author:** ![mwills](https://avatars.discourse-cdn.com/v4/letter/m/848f3c/32.png) [@mwills](https://forums.plex.tv/u/mwills)\
**Post date:** [March 24, 2011, 8:49pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/9 "2011-03-24T20:49:58Z")

</div>

i’m also having issues with the music scanner on a windows machine. is it possible to use this scanner on the Windows PMS?

---

<div class="post-metadata">

**Author:** ![elan](https://sea1.discourse-cdn.com/plex/user_avatar/forums.plex.tv/elan/32/5_2.png) [@elan](https://forums.plex.tv/u/elan)\
**Post date:** [March 24, 2011, 10:40pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/10 "2011-03-24T22:40:47Z")

</div>

> [@](#):
>
> I can't get the Windows version of PMS do register new scanners. Has anyone succeeded in using a custom scanner? Pretty sure I'm in the right directory:  
> C:\Documents and Settings\Administrator\Local Settings\Application Data\Plex Media Server\Plug-ins\Scanners.bundle\Contents\Resources\Movies

  
  
I'm sorry, unfortunately the Windows version of PMS does not support custom scanners yet.

---

<div class="post-metadata">

**Author:** ![naskoboy](https://avatars.discourse-cdn.com/v4/letter/n/a698b9/32.png) [@naskoboy](https://forums.plex.tv/u/naskoboy)\
**Post date:** [March 26, 2011, 10:51pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/11 "2011-03-26T22:51:11Z")

</div>

Not having custoim scanners on windows is really bad ☹ Shouldn’t be that hard to implement. Any idea when this might be implemented ?  
  
thanks

> [@](#):
>
> I'm sorry, unfortunately the Windows version of PMS does not support custom scanners yet.

---

<div class="post-metadata">

**Author:** ![naskoboy](https://avatars.discourse-cdn.com/v4/letter/n/a698b9/32.png) [@naskoboy](https://forums.plex.tv/u/naskoboy)\
**Post date:** [March 26, 2011, 10:59pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/12 "2011-03-26T22:59:42Z")

</div>

Can somebody tell me pls how to tweak the existing “Plex Music Scanner” ?  
  
I put in there few “print” statements but I see no difference whatsoever ?!?  
  
DOnt understand why PMS isnt picking up the changed file (I did restart the server)  
  
thanks

---

<div class="post-metadata">

**Author:** ![cjlucas](https://avatars.discourse-cdn.com/v4/letter/c/94ad74/32.png) [@cjlucas](https://forums.plex.tv/u/cjlucas)\
**Post date:** [May 16, 2011, 9:27pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/13 "2011-05-16T21:27:05Z")

</div>

Any word on when this feature is coming to windows?

---

<div class="post-metadata">

**Author:** ![baa](https://sea1.discourse-cdn.com/plex/user_avatar/forums.plex.tv/baa/32/2026_2.png) [@baa](https://forums.plex.tv/u/baa)\
**Post date:** [September 30, 2011, 6:52pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/14 "2011-09-30T18:52:52Z")

</div>

> [@](#):
>
> Can somebody tell me pls how to tweak the existing "Plex Music Scanner" ?  
> I put in there few "print" statements but I see no difference whatsoever ?!?  
> DOnt understand why PMS isnt picking up the changed file (I did restart the server)  
> thanks

  
  
The python print output won't be seen on the screen directly. It usually is routed to the LOG files, located in /Library/Logs/... easier accessible using the console.app - just guessing that you are running the PMS on a Mac.  
Try the "Plex Media Server" or better yet the "Plex Media Scanner.log"  
  
As long as your new prints don't brake the scanner you really shouldn't see anything different directly in PMS. You have to check the logs.  
  
Do you have more details on what you are doing/what you want to do? Might help for deeper answers... :-)

---

<div class="post-metadata">

**Author:** ![rye](https://avatars.discourse-cdn.com/v4/letter/r/e56c9b/32.png) [@rye](https://forums.plex.tv/u/rye)\
**Post date:** [November 10, 2011, 8:04pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/15 "2011-11-10T20:04:21Z")

</div>

once you make a movie folder what do you do with the text you need to write what do you need to save it has i may be a noob but your info dont explain much at all

---

<div class="post-metadata">

**Author:** ![psycik](https://avatars.discourse-cdn.com/v4/letter/p/b77776/32.png) [@psycik](https://forums.plex.tv/u/psycik)\
**Post date:** [March 22, 2012, 6:52pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/16 "2012-03-22T18:52:15Z")

</div>

Any word on when custom scanners might be available in windows PMS?

---

<div class="post-metadata">

**Author:** ![elan](https://sea1.discourse-cdn.com/plex/user_avatar/forums.plex.tv/elan/32/5_2.png) [@elan](https://forums.plex.tv/u/elan)\
**Post date:** [March 22, 2012, 11:01pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/17 "2012-03-22T23:01:47Z")

</div>

> [@](#):
>
> Any word on when custom scanners might be available in windows PMS?

  
  
They are supported now, I'm not aware of any issues.

---

<div class="post-metadata">

**Author:** ![tmar89](https://avatars.discourse-cdn.com/v4/letter/t/9de053/32.png) [@tmar89](https://forums.plex.tv/u/tmar89)\
**Post date:** [April 10, 2012, 2:31pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/18 "2012-04-10T14:31:36Z")

</div>

What would you recommend reading to learn how to write a custom scanner for someone without any python experience?

---

<div class="post-metadata">

**Author:** ![psycik](https://avatars.discourse-cdn.com/v4/letter/p/b77776/32.png) [@psycik](https://forums.plex.tv/u/psycik)\
**Post date:** [April 10, 2012, 5:57pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/19 "2012-04-10T17:57:22Z")

</div>

Just copy one and play with it. If you’re familiar with other languages you can pick it up from 0 python experience.  
  
  
  
That’s what I’ve done.

---

<div class="post-metadata">

**Author:** ![psycik](https://avatars.discourse-cdn.com/v4/letter/p/b77776/32.png) [@psycik](https://forums.plex.tv/u/psycik)\
**Post date:** [July 16, 2012, 7:37pm UTC](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960/20 "2012-07-16T19:37:56Z")

</div>

Why would a custom scanner be deleted? It works when I copy the .py file into the correct directory but after a few days I find it’s been deleted. Nothing tells me why.  
  
  
  
Although I have just scanned with it and got a “Plex Media Scanner has stopped working” - I think on thumbnail extraction. Hm nope, it’s still there.  
  
  
  
Any ideas?

[Next page](https://forums.plex.tv/t/how-to-install-a-custom-scanner/5960.md?page=2)
