README.rdoc in royw-dvdprofiler2xbmc-0.0.5 vs README.rdoc in royw-dvdprofiler2xbmc-0.0.6
- old
+ new
@@ -3,32 +3,52 @@
* http://www.github.com/royw/dvdprofiler2xbmc
== STATUS
The initial goal of using DVD Profiler data when available along
-with IMDB data otherwise is just about met. There is still some
-performance issues mainly related to using the production or
-released years to refine searches that have multiple title matches.
+with IMDB data otherwise is met.
Near term plans include:
* supporting multiple file matching patterns
* supporting directory containers
-* interfacing to TMDb, primarily for fanart.
== DESCRIPTION:
This script will attempt to match up media files from a set of directories
to the collection.xml file exported from DVD Profiler. For matches, the
script will then create a {moviename}.nfo from the data in collections.xml
and also copy the front cover image to {moviename}.tbn. Both files will
-be placed in the same directory as the source media file.
+be placed in the same directory as the source media file. Also the specific
+profile information for each movie will be saved into
+{moviename}.dvdprofiler.xml.
-Then on XBMC, set the source content to none to remove the meta data from
-the library, then set the source content back to Movies to import the
-media. This time, the data in the .nfo files will be used instead of
-scraping.
+The script will then search IMDB for a title or also known as (AKA) match.
+If necessary, the script will refine the search by using the media year
+(year in media filename), then dvdprofiler production year, then dvdprofiler
+release year, then try again with each year plus or minus a year. The IMDB
+profile found will be saved as {moviename}.imdb.xml.
+Next the script will use the IMDB ID to query themovieDb.com. This is
+primarily to retrieve any fanart but will also add any missing parameters
+to the .nfo file (very unlikely). The TMDB profile found will be saved as
+{moviename}.tmdb.xml.
+
+So in summary the files generated are:
+
+{moviename}.tmdb.xml - profile from themovieDb.com
+{moviename}.imdb.xml - profile from imdb.com
+{moviename}.dvdprofiler.xml - profile from collection.xml
+{moviename}-fanart.jpg - first fanart image from themovieDb.com
+{moviename}.tbn - image from DVD Profiler
+{moviename}.nfo - generated info profile for xbmc
+
+To force regeneration, simply delete these files then run the script again.
+
+Then on XBMC, set the source content to none to remove the meta data from the
+library, then set the source content back to Movies to import the media.
+This time, the data in the .nfo files will be used instead of scraping.
+
== NOTES:
1) Currently only supports file based media containers, not directory
based.
@@ -43,16 +63,23 @@
== FEATURES/PROBLEMS:
Features:
-* Creates .nfo files from exported collection.xml from DVD Profiler
+* Creates .nfo files from exported collection.xml from DVD Profiler and
+ imdb.com.
* If .nfo does not have an <id> tag, then tries to find the IMDB ID by
using the title and production/release years to search IMDB.
* Sets file permissions for files and directories
* Media can be contained in a set of directories (they can be mount points)
* Adds sub-directory names as genres to .nfo files
+* To prevent reporting missing ISBN, "touch {moviename}.no_isbn" (this is
+ useful to ignore boxed sets)
+* To prevent lookup on imdb, "touch {moviename}.no_imdb_lookup" (this is
+ useful for titles you know are not on imdb.com)
+* To prevent lookup on tmdb, "touch {moviename}.no_tmdb_lookup" (this is
+ useful for titles you know are not on themovieDb.com)
Problems:
* IMDB ID scraping doesn't handle boxed sets or multiple movies per media
file. I don't see how to work around this exept to eliminate from media
@@ -125,10 +152,10 @@
== REQUIREMENTS:
* ruby 1.8.x
* rubygem
-* my imdb fork on github (gem install )
+* my imdb fork on github (sudo gem install royw-imdb)
== INSTALL:
sudo gem install royw-dvdprofiler2xbmc
\ No newline at end of file