From 90ba3d0fa200776e14b88bab1582065f6fe414dc Mon Sep 17 00:00:00 2001 From: "itdrui.de" Date: Sun, 1 Feb 2026 18:06:46 +0100 Subject: [PATCH] Update docs --- .gitignore | 5 +++++ docs/PLUGIN_SYSTEM.md | 14 +++++++------- 2 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fde90de --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Local-only notes +/docs/PROJECT_NOTES.md + +# Local install output +/install/ diff --git a/docs/PLUGIN_SYSTEM.md b/docs/PLUGIN_SYSTEM.md index 2867799..02ab643 100644 --- a/docs/PLUGIN_SYSTEM.md +++ b/docs/PLUGIN_SYSTEM.md @@ -4,7 +4,7 @@ Dieses Dokument beschreibt, wie das Plugin-System von **ViewIt** funktioniert un ### Überblick -ViewIt lädt Provider-Integrationen dynamisch aus `source/kodi_addon/plugins/*.py`. Jede Datei enthält eine Klasse, die von `BasisPlugin` erbt. Beim Start werden alle Plugins instanziiert und nur aktiv genutzt, wenn sie verfügbar sind. +ViewIt lädt Provider-Integrationen dynamisch aus `addon/plugins/*.py`. Jede Datei enthält eine Klasse, die von `BasisPlugin` erbt. Beim Start werden alle Plugins instanziiert und nur aktiv genutzt, wenn sie verfügbar sind. ### Aktuelle Plugins @@ -16,9 +16,9 @@ ViewIt lädt Provider-Integrationen dynamisch aus `source/kodi_addon/plugins/*.p ### Plugin-Discovery (Ladeprozess) -Der Loader in `source/kodi_addon/default.py`: +Der Loader in `addon/default.py`: -1. Sucht alle `*.py` in `source/kodi_addon/plugins/` +1. Sucht alle `*.py` in `addon/plugins/` 2. Überspringt Dateien, die mit `_` beginnen 3. Lädt Module dynamisch 4. Instanziert Klassen, die von `BasisPlugin` erben @@ -28,7 +28,7 @@ Damit bleiben fehlerhafte Plugins isoliert und blockieren nicht das gesamte Add- ### BasisPlugin – verpflichtende Methoden -Definiert in `source/kodi_addon/plugin_interface.py`: +Definiert in `addon/plugin_interface.py`: - `async search_titles(query: str) -> list[str]` - `seasons_for(title: str) -> list[str]` @@ -59,12 +59,12 @@ Eine Integration sollte typischerweise bieten: - `stream_link_for()` optional für direkte Playback-Links - Optional: `available_hosters_for()` oder Provider-spezifische Helfer -Als Startpunkt dient `source/kodi_addon/plugins/_template_plugin.py`. +Als Startpunkt dient `addon/plugins/_template_plugin.py`. ### Community-Erweiterungen (Workflow) 1. Fork/Branch erstellen -2. Neue Datei unter `source/kodi_addon/plugins/` hinzufügen (z. B. `meinprovider_plugin.py`) +2. Neue Datei unter `addon/plugins/` hinzufügen (z. B. `meinprovider_plugin.py`) 3. Klasse erstellen, die `BasisPlugin` implementiert 4. In Kodi testen (ZIP bauen, installieren) 5. PR öffnen @@ -88,4 +88,4 @@ Provider sollten URL-Logging optional halten (Settings). ./scripts/build_kodi_zip.sh ``` -Das ZIP liegt anschließend unter `install/plugin.video.viewit-.zip`. +Das ZIP liegt anschließend unter `dist/plugin.video.viewit-.zip`.