From 8fff13e89ec824407c8e103db94978c716d15d5d Mon Sep 17 00:00:00 2001
From: Yangning <anonymous94@live.cn>
Date: Thu, 9 Nov 2023 23:32:48 +0800
Subject: [PATCH] feat: Start from tinyMediaManager/scraperaddonsample

see https://gitlab.com/tinyMediaManager/scraperaddonsample
---
 .classpath                                    |  32 ++++++
 .gitignore                                    |  29 +++++
 .project                                      |  23 ++++
 .settings/org.eclipse.jdt.core.prefs          |   8 ++
 README.md                                     |  19 ++++
 pom.xml                                       |  32 ++++++
 .../spisample/SampleAddonProvider.java        |  44 ++++++++
 .../spisample/SampleMovieArtworkProvider.java |  40 +++++++
 .../SampleMovieMetadataProvider.java          | 101 ++++++++++++++++++
 .../SampleMovieSubtitleProvider.java          |  40 +++++++
 .../spisample/SampleMovieTrailerProvider.java |  40 +++++++
 .../SampleTvShowArtworkProvider.java          |  40 +++++++
 .../SampleTvShowMetadataProvider.java         |  57 ++++++++++
 .../SampleTvShowSubtitleProvider.java         |  40 +++++++
 .../SampleTvShowTrailerProvider.java          |  43 ++++++++
 ...inymediamanager.scraper.spi.IAddonProvider |   1 +
 .../scraper/spisample/messages.properties     |   1 +
 .../scraper/spisample/messages_de.properties  |   1 +
 .../scraper/spisample/tmm_logo.svg            |  38 +++++++
 19 files changed, 629 insertions(+)
 create mode 100644 .classpath
 create mode 100644 .gitignore
 create mode 100644 .project
 create mode 100644 .settings/org.eclipse.jdt.core.prefs
 create mode 100644 README.md
 create mode 100644 pom.xml
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleAddonProvider.java
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieArtworkProvider.java
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieMetadataProvider.java
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieSubtitleProvider.java
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieTrailerProvider.java
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowArtworkProvider.java
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowMetadataProvider.java
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowSubtitleProvider.java
 create mode 100644 src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowTrailerProvider.java
 create mode 100644 src/main/resources/META-INF/services/org.tinymediamanager.scraper.spi.IAddonProvider
 create mode 100644 src/main/resources/org/tinymediamanager/scraper/spisample/messages.properties
 create mode 100644 src/main/resources/org/tinymediamanager/scraper/spisample/messages_de.properties
 create mode 100644 src/main/resources/org/tinymediamanager/scraper/spisample/tmm_logo.svg

diff --git a/.classpath b/.classpath
new file mode 100644
index 000000000..234db15be
--- /dev/null
+++ b/.classpath
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" output="target/classes" path="src/main/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="test" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-11">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="output" path="target/classes"/>
+</classpath>
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 000000000..aae4277a9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,29 @@
+*.class
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.war
+*.ear
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+javacore*
+jitdump*
+Snap*
+
+#Maven
+target
+release.properties
+pom.xml.*
+
+#IntelliJ IDEA
+.idea/
+*.iml
+
+#Eclipse
+/bin
+
+#Vim
+*.swp
diff --git a/.project b/.project
new file mode 100644
index 000000000..0accce8e5
--- /dev/null
+++ b/.project
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>scraperaddonsample</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.m2e.core.maven2Builder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+		<nature>org.eclipse.m2e.core.maven2Nature</nature>
+	</natures>
+</projectDescription>
diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs
new file mode 100644
index 000000000..2af1e7b99
--- /dev/null
+++ b/.settings/org.eclipse.jdt.core.prefs
@@ -0,0 +1,8 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=11
+org.eclipse.jdt.core.compiler.compliance=11
+org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
+org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=ignore
+org.eclipse.jdt.core.compiler.release=disabled
+org.eclipse.jdt.core.compiler.source=11
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..dc8f18c44
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Scraper-Addon Sample
+This project is a sample/template for a scraper addon which can be loaded in tinyMediaManager
+
+## i18n
+tinyMediaManager can read localized scraper option names from the custom scraper via an own `ResourceBundle` (v4.3.9+).
+
+To use a custom `ResourceBundle` you need to
+
+1. Create your own properties files containing the literals/translated contents (see `src/main/java/org/tinymediamanager/scraper/spisample/messages.properties`)
+2. Register your `ResourceBundle` in the `MediaProviderInfo`
+```java
+// the ResourceBundle to offer i18n support for scraper options
+providerInfo.setResourceBundle(ResourceBundle.getBundle("org.tinymediamanager.scraper.spisample.messages"));
+```
+3. Add a text for every option in the following form to the properties file
+```
+#scraper.<scraper id>.<option name>=<text>
+scraper.spi-sample.text=Text field
+```
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 000000000..beb365f0e
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>org.tinymediamanager</groupId>
+    <artifactId>scraper-addon-sample</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <repositories>
+        <repository>
+            <id>gitlab-maven</id>
+            <url>https://gitlab.com/api/v4/projects/9945251/packages/maven</url>
+        </repository>
+    </repositories>
+
+    <properties>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.tinymediamanager</groupId>
+            <artifactId>tinyMediaManager</artifactId>
+            <version>4.3.9</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleAddonProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleAddonProvider.java
new file mode 100644
index 000000000..1875efc85
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleAddonProvider.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012 - 2020 Manuel Laggner
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.tinymediamanager.scraper.spisample;
+
+import org.tinymediamanager.scraper.interfaces.IMediaProvider;
+import org.tinymediamanager.scraper.spi.IAddonProvider;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class SampleAddonProvider implements IAddonProvider {
+
+  @Override
+  public List<Class<? extends IMediaProvider>> getAddonClasses() {
+    List<Class<? extends IMediaProvider>> addons = new ArrayList<>();
+
+    // this is the detailed example
+    addons.add(SampleMovieMetadataProvider.class);
+
+    // these are just empty classes to show how multiple sub-scrapers can be passed to tmm
+    addons.add(SampleMovieArtworkProvider.class);
+    addons.add(SampleMovieTrailerProvider.class);
+    addons.add(SampleMovieSubtitleProvider.class);
+    addons.add(SampleTvShowMetadataProvider.class);
+    addons.add(SampleTvShowArtworkProvider.class);
+    addons.add(SampleTvShowTrailerProvider.class);
+    addons.add(SampleTvShowSubtitleProvider.class);
+
+    return addons;
+  }
+}
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieArtworkProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieArtworkProvider.java
new file mode 100644
index 000000000..d27603c07
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieArtworkProvider.java
@@ -0,0 +1,40 @@
+package org.tinymediamanager.scraper.spisample;
+
+import org.tinymediamanager.scraper.ArtworkSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.MediaProviderInfo;
+import org.tinymediamanager.scraper.entities.MediaArtwork;
+import org.tinymediamanager.scraper.exceptions.MissingIdException;
+import org.tinymediamanager.scraper.exceptions.ScrapeException;
+import org.tinymediamanager.scraper.interfaces.IMovieArtworkProvider;
+
+import java.util.Collections;
+import java.util.List;
+
+public class SampleMovieArtworkProvider implements IMovieArtworkProvider {
+
+  private final MediaProviderInfo providerInfo;
+
+  public SampleMovieArtworkProvider() {
+    providerInfo = createProviderInfo();
+  }
+
+  private MediaProviderInfo createProviderInfo() {
+    return new MediaProviderInfo("spi-sample", "movie", "SPI Sample", "A sample for a dynamic movie artwork scraper");
+  }
+
+  @Override
+  public MediaProviderInfo getProviderInfo() {
+    return providerInfo;
+  }
+
+  @Override
+  public boolean isActive() {
+    return true;
+  }
+
+  @Override
+  public List<MediaArtwork> getArtwork(ArtworkSearchAndScrapeOptions artworkSearchAndScrapeOptions) throws ScrapeException, MissingIdException {
+    return Collections.emptyList();
+  }
+}
+
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieMetadataProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieMetadataProvider.java
new file mode 100644
index 000000000..045a6d1fc
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieMetadataProvider.java
@@ -0,0 +1,101 @@
+package org.tinymediamanager.scraper.spisample;
+
+import org.joda.time.DateTime;
+import org.tinymediamanager.core.entities.MediaRating;
+import org.tinymediamanager.core.movie.MovieSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.MediaMetadata;
+import org.tinymediamanager.scraper.MediaProviderInfo;
+import org.tinymediamanager.scraper.MediaSearchResult;
+import org.tinymediamanager.scraper.entities.MediaCertification;
+import org.tinymediamanager.scraper.entities.MediaType;
+import org.tinymediamanager.scraper.exceptions.ScrapeException;
+import org.tinymediamanager.scraper.interfaces.IMovieMetadataProvider;
+
+import java.util.ResourceBundle;
+import java.util.SortedSet;
+import java.util.TreeSet;
+
+public class SampleMovieMetadataProvider implements IMovieMetadataProvider {
+
+  private final MediaProviderInfo providerInfo;
+
+  public SampleMovieMetadataProvider() {
+    providerInfo = createProviderInfo();
+  }
+
+  private MediaProviderInfo createProviderInfo() {
+    MediaProviderInfo info = new MediaProviderInfo("spi-sample", "movie", "SPI Sample", "A sample for a dynamic movie metadata scraper", SampleMovieMetadataProvider.class.getResource("/org/tinymediamanager/scraper/spisample/tmm_logo.svg"));
+    // the ResourceBundle to offer i18n support for scraper options
+    info.setResourceBundle(ResourceBundle.getBundle("org.tinymediamanager.scraper.spisample.messages"));
+
+    // create configuration properties
+    info.getConfig().addText("text", "", false);
+    info.getConfig().addBoolean("boolean", true);
+    info.getConfig().addInteger("integer", 10);
+    info.getConfig().addSelect("select", new String[]{"A", "B", "C"}, "A");
+
+    // load any existing values from the storage
+    info.getConfig().load();
+
+    return info;
+  }
+
+  @Override
+  public MediaProviderInfo getProviderInfo() {
+    return providerInfo;
+  }
+
+  @Override
+  public boolean isActive() {
+    return true;
+  }
+
+  @Override
+  public SortedSet<MediaSearchResult> search(MovieSearchAndScrapeOptions movieSearchAndScrapeOptions) throws ScrapeException {
+    SortedSet<MediaSearchResult> results = new TreeSet<>();
+    MediaSearchResult result = new MediaSearchResult(getId(), MediaType.MOVIE);
+
+    // set the values of the search result.
+    // id, title, year and score is needed
+    result.setId(getId());
+    result.setTitle("This is a result");
+    result.setYear(2021);
+
+    // set the search score. should be calculated from the search query
+    // you can use the helper either
+    result.calculateScore(movieSearchAndScrapeOptions);
+    // or set the score directly (0...1)
+    result.setScore(1.0f);
+
+    results.add(result);
+
+    // more detailed example can be found in the tmm repo:
+    // https://gitlab.com/tinyMediaManager/tinyMediaManager/-/tree/devel/src/main/java/org/tinymediamanager/scraper
+
+    return results;
+  }
+
+  @Override
+  public MediaMetadata getMetadata(MovieSearchAndScrapeOptions movieSearchAndScrapeOptions) throws ScrapeException {
+    MediaMetadata mediaMetadata = new MediaMetadata(getId());
+
+    // here you may set all available data
+    mediaMetadata.setTitle("title");
+    mediaMetadata.setOriginalTitle("original title");
+    mediaMetadata.setPlot("the plot of the movie");
+    mediaMetadata.setYear(2021);
+    mediaMetadata.setReleaseDate(DateTime.parse("2010-06-30"));
+    mediaMetadata.setId(getId(), 1234);
+    mediaMetadata.setId(MediaMetadata.IMDB, "tt123456");
+    mediaMetadata.addRating(new MediaRating(getId(), 5.5f, 200, 10));
+    mediaMetadata.addRating(new MediaRating(MediaMetadata.IMDB, 7.8f, 20000));
+    mediaMetadata.addCertification(MediaCertification.US_G);
+    mediaMetadata.addCertification(MediaCertification.DE_FSK12);
+
+    // more detailed example can be found in the tmm repo:
+    // https://gitlab.com/tinyMediaManager/tinyMediaManager/-/tree/devel/src/main/java/org/tinymediamanager/scraper
+
+    return mediaMetadata;
+  }
+}
+
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieSubtitleProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieSubtitleProvider.java
new file mode 100644
index 000000000..632cf4538
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieSubtitleProvider.java
@@ -0,0 +1,40 @@
+package org.tinymediamanager.scraper.spisample;
+
+import org.tinymediamanager.scraper.MediaProviderInfo;
+import org.tinymediamanager.scraper.SubtitleSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.SubtitleSearchResult;
+import org.tinymediamanager.scraper.exceptions.MissingIdException;
+import org.tinymediamanager.scraper.exceptions.ScrapeException;
+import org.tinymediamanager.scraper.interfaces.IMovieSubtitleProvider;
+
+import java.util.Collections;
+import java.util.List;
+
+public class SampleMovieSubtitleProvider implements IMovieSubtitleProvider {
+
+  private final MediaProviderInfo providerInfo;
+
+  public SampleMovieSubtitleProvider() {
+    providerInfo = createProviderInfo();
+  }
+
+  private MediaProviderInfo createProviderInfo() {
+    return new MediaProviderInfo("spi-sample", "movie_subtitle", "SPI Sample", "A sample for a dynamic movie subtitle scraper");
+  }
+
+  @Override
+  public MediaProviderInfo getProviderInfo() {
+    return providerInfo;
+  }
+
+  @Override
+  public boolean isActive() {
+    return true;
+  }
+
+  @Override
+  public List<SubtitleSearchResult> search(SubtitleSearchAndScrapeOptions subtitleSearchAndScrapeOptions) throws ScrapeException, MissingIdException {
+    return Collections.emptyList();
+  }
+}
+
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieTrailerProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieTrailerProvider.java
new file mode 100644
index 000000000..9befc0544
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleMovieTrailerProvider.java
@@ -0,0 +1,40 @@
+package org.tinymediamanager.scraper.spisample;
+
+import org.tinymediamanager.core.entities.MediaTrailer;
+import org.tinymediamanager.scraper.MediaProviderInfo;
+import org.tinymediamanager.scraper.TrailerSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.exceptions.MissingIdException;
+import org.tinymediamanager.scraper.exceptions.ScrapeException;
+import org.tinymediamanager.scraper.interfaces.IMovieTrailerProvider;
+
+import java.util.Collections;
+import java.util.List;
+
+public class SampleMovieTrailerProvider implements IMovieTrailerProvider {
+
+  private final MediaProviderInfo providerInfo;
+
+  public SampleMovieTrailerProvider() {
+    providerInfo = createProviderInfo();
+  }
+
+  private MediaProviderInfo createProviderInfo() {
+    return new MediaProviderInfo("spi-sample", "movie_trailer", "SPI Sample", "A sample for a dynamic movie trailer scraper");
+  }
+
+  @Override
+  public MediaProviderInfo getProviderInfo() {
+    return providerInfo;
+  }
+
+  @Override
+  public boolean isActive() {
+    return true;
+  }
+
+  @Override
+  public List<MediaTrailer> getTrailers(TrailerSearchAndScrapeOptions trailerSearchAndScrapeOptions) throws ScrapeException, MissingIdException {
+    return Collections.emptyList();
+  }
+}
+
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowArtworkProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowArtworkProvider.java
new file mode 100644
index 000000000..fe4eef869
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowArtworkProvider.java
@@ -0,0 +1,40 @@
+package org.tinymediamanager.scraper.spisample;
+
+import org.tinymediamanager.scraper.ArtworkSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.MediaProviderInfo;
+import org.tinymediamanager.scraper.entities.MediaArtwork;
+import org.tinymediamanager.scraper.exceptions.MissingIdException;
+import org.tinymediamanager.scraper.exceptions.ScrapeException;
+import org.tinymediamanager.scraper.interfaces.ITvShowArtworkProvider;
+
+import java.util.Collections;
+import java.util.List;
+
+public class SampleTvShowArtworkProvider implements ITvShowArtworkProvider {
+
+  private final MediaProviderInfo providerInfo;
+
+  public SampleTvShowArtworkProvider() {
+    providerInfo = createProviderInfo();
+  }
+
+  private MediaProviderInfo createProviderInfo() {
+    return new MediaProviderInfo("spi-sample", "tvshow_artwork", "SPI Sample", "A sample for a dynamic TV show artwork scraper");
+  }
+
+  @Override
+  public MediaProviderInfo getProviderInfo() {
+    return providerInfo;
+  }
+
+  @Override
+  public boolean isActive() {
+    return true;
+  }
+
+  @Override
+  public List<MediaArtwork> getArtwork(ArtworkSearchAndScrapeOptions artworkSearchAndScrapeOptions) throws ScrapeException, MissingIdException {
+    return Collections.emptyList();
+  }
+}
+
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowMetadataProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowMetadataProvider.java
new file mode 100644
index 000000000..9b5dc01b3
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowMetadataProvider.java
@@ -0,0 +1,57 @@
+package org.tinymediamanager.scraper.spisample;
+
+import org.tinymediamanager.core.tvshow.TvShowEpisodeSearchAndScrapeOptions;
+import org.tinymediamanager.core.tvshow.TvShowSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.MediaMetadata;
+import org.tinymediamanager.scraper.MediaProviderInfo;
+import org.tinymediamanager.scraper.MediaSearchResult;
+import org.tinymediamanager.scraper.exceptions.ScrapeException;
+import org.tinymediamanager.scraper.interfaces.ITvShowMetadataProvider;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.SortedSet;
+
+public class SampleTvShowMetadataProvider implements ITvShowMetadataProvider {
+
+  private final MediaProviderInfo providerInfo;
+
+  public SampleTvShowMetadataProvider() {
+    this.providerInfo = createProviderInfo();
+  }
+
+  private MediaProviderInfo createProviderInfo() {
+    return new MediaProviderInfo("spi-sample", "tvShow", "SPI Sample", "A sample for a dynamic TV show metadata scraper");
+  }
+
+  @Override
+  public MediaProviderInfo getProviderInfo() {
+    return providerInfo;
+  }
+
+  @Override
+  public boolean isActive() {
+    return true;
+  }
+
+  @Override
+  public MediaMetadata getMetadata(TvShowSearchAndScrapeOptions tvShowSearchAndScrapeOptions) throws ScrapeException {
+    return new MediaMetadata(getId());
+  }
+
+  @Override
+  public MediaMetadata getMetadata(TvShowEpisodeSearchAndScrapeOptions tvShowEpisodeSearchAndScrapeOptions) throws ScrapeException {
+    return new MediaMetadata(getId());
+  }
+
+  @Override
+  public SortedSet<MediaSearchResult> search(TvShowSearchAndScrapeOptions tvShowSearchAndScrapeOptions) throws ScrapeException {
+    return Collections.emptySortedSet();
+  }
+
+  @Override
+  public List<MediaMetadata> getEpisodeList(TvShowSearchAndScrapeOptions tvShowSearchAndScrapeOptions) throws ScrapeException {
+    return Collections.emptyList();
+  }
+}
+
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowSubtitleProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowSubtitleProvider.java
new file mode 100644
index 000000000..a2240c9fd
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowSubtitleProvider.java
@@ -0,0 +1,40 @@
+package org.tinymediamanager.scraper.spisample;
+
+import org.tinymediamanager.scraper.MediaProviderInfo;
+import org.tinymediamanager.scraper.SubtitleSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.SubtitleSearchResult;
+import org.tinymediamanager.scraper.exceptions.MissingIdException;
+import org.tinymediamanager.scraper.exceptions.ScrapeException;
+import org.tinymediamanager.scraper.interfaces.ITvShowSubtitleProvider;
+
+import java.util.Collections;
+import java.util.List;
+
+public class SampleTvShowSubtitleProvider implements ITvShowSubtitleProvider {
+
+  private final MediaProviderInfo providerInfo;
+
+  public SampleTvShowSubtitleProvider() {
+    providerInfo = createProviderInfo();
+  }
+
+  private MediaProviderInfo createProviderInfo() {
+    return new MediaProviderInfo("spi-sample", "tvshow_subtitle", "SPI Sample", "A sample for a dynamic TV show subtitle scraper");
+  }
+
+  @Override
+  public MediaProviderInfo getProviderInfo() {
+    return providerInfo;
+  }
+
+  @Override
+  public boolean isActive() {
+    return true;
+  }
+
+  @Override
+  public List<SubtitleSearchResult> search(SubtitleSearchAndScrapeOptions subtitleSearchAndScrapeOptions) throws ScrapeException, MissingIdException {
+    return Collections.emptyList();
+  }
+}
+
diff --git a/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowTrailerProvider.java b/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowTrailerProvider.java
new file mode 100644
index 000000000..910946bf2
--- /dev/null
+++ b/src/main/java/org/tinymediamanager/scraper/spisample/SampleTvShowTrailerProvider.java
@@ -0,0 +1,43 @@
+package org.tinymediamanager.scraper.spisample;
+
+import org.tinymediamanager.core.entities.MediaTrailer;
+import org.tinymediamanager.scraper.ArtworkSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.MediaProviderInfo;
+import org.tinymediamanager.scraper.TrailerSearchAndScrapeOptions;
+import org.tinymediamanager.scraper.entities.MediaArtwork;
+import org.tinymediamanager.scraper.exceptions.MissingIdException;
+import org.tinymediamanager.scraper.exceptions.ScrapeException;
+import org.tinymediamanager.scraper.interfaces.ITvShowArtworkProvider;
+import org.tinymediamanager.scraper.interfaces.ITvShowTrailerProvider;
+
+import java.util.Collections;
+import java.util.List;
+
+public class SampleTvShowTrailerProvider implements ITvShowTrailerProvider {
+
+  private final MediaProviderInfo providerInfo;
+
+  public SampleTvShowTrailerProvider() {
+    providerInfo = createProviderInfo();
+  }
+
+  private MediaProviderInfo createProviderInfo() {
+    return new MediaProviderInfo("spi-sample", "tvshow_trailer", "SPI Sample", "A sample for a dynamic TV show trailer scraper");
+  }
+
+  @Override
+  public MediaProviderInfo getProviderInfo() {
+    return providerInfo;
+  }
+
+  @Override
+  public boolean isActive() {
+    return true;
+  }
+
+  @Override
+  public List<MediaTrailer> getTrailers(TrailerSearchAndScrapeOptions trailerSearchAndScrapeOptions) throws ScrapeException, MissingIdException {
+    return Collections.emptyList();
+  }
+}
+
diff --git a/src/main/resources/META-INF/services/org.tinymediamanager.scraper.spi.IAddonProvider b/src/main/resources/META-INF/services/org.tinymediamanager.scraper.spi.IAddonProvider
new file mode 100644
index 000000000..c3bdc8369
--- /dev/null
+++ b/src/main/resources/META-INF/services/org.tinymediamanager.scraper.spi.IAddonProvider
@@ -0,0 +1 @@
+org.tinymediamanager.scraper.spisample.SampleAddonProvider
diff --git a/src/main/resources/org/tinymediamanager/scraper/spisample/messages.properties b/src/main/resources/org/tinymediamanager/scraper/spisample/messages.properties
new file mode 100644
index 000000000..4854cd0d2
--- /dev/null
+++ b/src/main/resources/org/tinymediamanager/scraper/spisample/messages.properties
@@ -0,0 +1 @@
+scraper.spi-sample.text=Text field
\ No newline at end of file
diff --git a/src/main/resources/org/tinymediamanager/scraper/spisample/messages_de.properties b/src/main/resources/org/tinymediamanager/scraper/spisample/messages_de.properties
new file mode 100644
index 000000000..105c20fce
--- /dev/null
+++ b/src/main/resources/org/tinymediamanager/scraper/spisample/messages_de.properties
@@ -0,0 +1 @@
+scraper.spi-sample.text=Textfeld
\ No newline at end of file
diff --git a/src/main/resources/org/tinymediamanager/scraper/spisample/tmm_logo.svg b/src/main/resources/org/tinymediamanager/scraper/spisample/tmm_logo.svg
new file mode 100644
index 000000000..e9b43c82a
--- /dev/null
+++ b/src/main/resources/org/tinymediamanager/scraper/spisample/tmm_logo.svg
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+        xmlns="http://www.w3.org/2000/svg"
+        xmlns:xlink="http://www.w3.org/1999/xlink"
+        width="499.04999"
+        height="196.47"
+        viewBox="0 0 499.04999 196.47"
+        version="1.1"
+        xml:space="preserve"
+        style="clip-rule:evenodd;fill-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2"
+        id="svg6">
+    <defs
+            id="defs10"><linearGradient
+   id="linearGradient18"><stop
+     style="stop-color:#ff7413;stop-opacity:1;"
+     offset="0"
+     id="stop14" /><stop
+            style="stop-color:#ffa100;stop-opacity:1;"
+            offset="1"
+            id="stop16"/></linearGradient>
+        <linearGradient
+                xlink:href="#linearGradient18"
+                id="linearGradient20"
+                x1="1889.2"
+                y1="2095.51"
+                x2="1890.385"
+                y2="1929.1329"
+                gradientUnits="userSpaceOnUse"/></defs>
+
+    <g
+            transform="translate(-1663.34,-1914.04)"
+            id="g4">
+        <path
+                d="m 1913.65,1980.21 h 18.83 l -1.69,7.99 c 6.46,-7.38 13.38,-8.77 18.76,-8.77 8.14,0 14.14,3.7 15.83,13.23 7.38,-11.37 15.68,-13.07 21.37,-13.07 9.84,0 17.06,5.07 17.06,17.37 0,12.46 -7.38,31.06 -7.38,39.67 0,3.84 1.54,6.46 6.15,6.46 6.74,0 9.51,-5.49 12.87,-13.42 l 10.48,-49.46 h 22.14 l -1.69,7.99 c 6.46,-7.38 13.37,-8.77 18.75,-8.77 8.15,0 14.15,3.7 15.84,13.23 7.38,-11.37 15.68,-13.07 21.37,-13.07 9.84,0 17.06,5.07 17.06,17.37 0,12.46 -7.38,31.06 -7.38,39.67 0,3.84 1.54,6.46 6.15,6.46 2.61,0 4.15,-0.31 5.08,-0.93 -1.39,11.07 -8.77,15.84 -16.92,15.84 -11.83,0 -15.52,-8.61 -15.52,-17.38 0,-10.45 6.91,-29.36 6.91,-39.2 0,-5.07 -1.84,-7.84 -5.53,-7.84 -5.54,0 -9.69,6.46 -11.99,14.15 l -10.45,49.34 h -22.14 l 11.22,-53.03 c 0.31,-1.23 0.46,-2.46 0.46,-3.85 0,-3.38 -1.23,-6.76 -4.61,-6.76 -6,0 -10.15,6.61 -12.45,14.3 l -10.45,49.34 h -22.14 l 1.56,-7.35 c -6.27,7.03 -12.77,8.28 -17.84,8.28 -13.37,0 -18.14,-8.61 -18.14,-17.38 0,-10.45 6.92,-29.36 6.92,-39.2 0,-5.07 -1.85,-7.84 -5.54,-7.84 -5.53,0 -9.68,6.46 -11.99,14.15 l -10.45,49.34 h -22.14 l 11.23,-53.03 c 0.3,-1.23 0.45,-2.46 0.45,-3.85 0,-3.38 -1.23,-6.76 -4.61,-6.76 -5.99,0 -10.15,6.61 -12.45,14.3 l -10.45,49.34 h -18.84 l -8.15,38.44 h -4.68 l 32.59,-153.74 h 4.69 z m -208.91,64.03 c -8.42,11.82 -18.67,13.76 -24.95,13.76 -9.23,0 -16.45,-5.54 -16.45,-18.45 0,-2.92 0.46,-6.3 1.23,-9.99 l 9.22,-43.2 h -5.07 l 1.23,-6.15 h 5.07 l 4.61,-21.22 22.75,-3.07 -5.22,24.29 h 9.22 l -1.23,6.15 h -9.22 l -9.84,46.12 c -0.46,2 -0.62,3.53 -0.62,4.92 0,4.3 2,5.69 6.31,5.69 5.97,0 11.49,-5.8 13.81,-13.45 l 0.02,-0.09 10.45,-49.35 h 22.14 l -11.07,52.28 c -0.46,2 -0.62,3.53 -0.62,4.92 0,4.3 2,5.68 6.31,5.68 5.96,0 11.46,-5.77 13.79,-13.39 l 10.49,-49.48 h 22.14 l -1.69,7.99 c 6.46,-7.38 13.22,-8.61 17.98,-8.61 9.84,0 17.07,5.07 17.07,17.37 0,12.46 -7.38,31.06 -7.38,39.67 0,3.84 1.54,6.46 6.15,6.46 6.75,0 9.52,-5.51 12.89,-13.48 l 0.01,-0.06 10.45,-49.35 h 22.14 l -11.07,52.28 c -0.3,1.22 -0.46,2.61 -0.46,3.84 0,3.53 1.08,6.76 4.61,6.76 5.99,0 9.99,-5.84 12.3,-13.53 l 10.45,-49.35 h 22.3 l -18.76,89.17 c -4.61,21.98 -17.83,26.13 -27.98,26.13 -9.38,0 -18.14,-6.6 -18.14,-16.6 0,-14.3 11.99,-18.75 26.6,-23.05 l 1.53,-6.77 c -6.61,7.53 -13.53,8.92 -18.75,8.92 -7.8,0 -14.17,-3.96 -15.95,-12.98 -7.28,11.2 -15.35,12.98 -21.4,12.98 -13.37,0 -18.13,-8.61 -18.13,-17.38 0,-10.45 6.91,-29.36 6.91,-39.2 0,-5.07 -1.84,-7.84 -5.53,-7.84 -5.53,0 -9.69,6.46 -11.99,14.15 l -10.46,49.34 h -22.13 l 1.91,-9.04 c -7.73,8.46 -16.35,9.97 -21.89,9.97 -8.02,0 -14.53,-4.18 -16.09,-13.76 z m 139.97,37.58 c 3.08,0 7.08,-2.92 9.08,-11.99 l 1.84,-9.07 c -9.69,3.23 -17.07,7.69 -17.07,15.99 0,2.15 2.77,5.07 6.15,5.07 z m -113.43,-134.36 c 6.77,0 12.3,5.54 12.3,12.3 0,6.77 -5.53,12.14 -12.3,12.14 -6.77,0 -12.15,-5.37 -12.15,-12.14 0,-6.76 5.38,-12.3 12.15,-12.3 z m 411.52,-18.42 c -10.8,0 -19.58,8.79 -19.58,19.58 0,10.8 8.78,19.59 19.58,19.59 10.8,0 19.59,-8.79 19.59,-19.59 0,-10.79 -8.79,-19.58 -19.59,-19.58 z m 0,34.89 c -8.44,0 -15.31,-6.86 -15.31,-15.31 0,-7.05 4.81,-12.99 11.31,-14.76 l -2.67,12.53 c -0.28,1.35 -0.45,2.59 -0.45,3.65 0,4.72 2.64,6.74 6.01,6.74 3.03,0 8.59,-1.23 11.79,-10.39 h -2.35 c -0.85,2.81 -2.87,4.95 -5.06,4.95 -1.57,0 -2.3,-0.51 -2.3,-2.08 0,-0.51 0.05,-1.07 0.22,-1.8 l 2.9,-13.57 c 6.46,1.79 11.23,7.71 11.23,14.73 0,8.45 -6.88,15.31 -15.32,15.31 z"
+                style="fill:url(#linearGradient20);fill-opacity:1;fill-rule:nonzero"
+                id="path2"/>
+    </g>
+</svg>