diff options
Diffstat (limited to 'doc/import/providers.md')
-rw-r--r-- | doc/import/providers.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/import/providers.md b/doc/import/providers.md new file mode 100644 index 0000000..9b438c6 --- /dev/null +++ b/doc/import/providers.md @@ -0,0 +1,71 @@ +# Metadata Providers + +## `override` + +Allows for manual hardcoded metadata. + +Special to this option are the `poster` and `backdrop` properties in the +`private` section. These are reference images local to _library\_path_ and +directly set the counterparts in `public`. + +### Example + +```yaml +id: library +sources: + - !override + public: + kind: !collection + title: "My Library" + children: + - movies + - stuff + private: + poster: library.png +``` + +## `auto_children` + +Scans the directory of the file currently processed for `*.yaml` and `.jelly`, +parses their ID and adds them as `children`. + +## `media` + +This references a media file on disk and links it to this node. Additionally it +extracts matroska metadata aswell. + +> [!NOTE] +> If `path` is a directory, then these options are applied recursively +> all files inside, automatically creating new nodes based on inferred IDs and +> linking them up. + +### Example + +```yaml +id: decay-2012 +sources: +- !media + path: /movies/decay.webm + ignore_metadata: true + ignore_attachments: false + ignore_chapters: false +``` + +## `trakt` + +The recommended provider for any movie, show or season. It automatically queries +other linked APIs. + +### Example + +```yaml +id: decay-2012 +sources: +- !trakt + kind: movie + id: 98052 +``` + +## `tmdb` + +Just like `trakt` but uses only TMDB instead. |