docs: rewrite README and docs to concise ASCII style
This commit is contained in:
@@ -1,55 +1,49 @@
|
||||
# ViewIT – Hauptlogik (`addon/default.py`)
|
||||
# ViewIT Hauptlogik (`addon/default.py`)
|
||||
|
||||
Dieses Dokument beschreibt den Einstiegspunkt des Addons und die zentrale Steuerlogik.
|
||||
Diese Datei ist der Router des Addons.
|
||||
Sie verbindet Kodi UI, Plugin Calls und Playback.
|
||||
|
||||
## Aufgabe der Datei
|
||||
`addon/default.py` ist der Router des Addons. Er:
|
||||
- lädt die Plugin‑Module dynamisch,
|
||||
- stellt die Kodi‑Navigation bereit,
|
||||
- übersetzt UI‑Aktionen in Plugin‑Aufrufe,
|
||||
- startet die Wiedergabe und verwaltet Playstate/Resume.
|
||||
## Kernaufgabe
|
||||
- Plugins laden
|
||||
- Menues bauen
|
||||
- Aktionen auf Plugin Methoden mappen
|
||||
- Playback starten
|
||||
- Playstate speichern
|
||||
|
||||
## Ablauf (high level)
|
||||
1. **Plugin‑Discovery**: Lädt alle `addon/plugins/*.py` (ohne `_`‑Prefix). Bevorzugt `Plugin = <Klasse>`, sonst werden `BasisPlugin`‑Subklassen deterministisch instanziiert.
|
||||
2. **Navigation**: Baut Kodi‑Listen (Serien/Staffeln/Episoden) auf Basis der Plugin‑Antworten.
|
||||
3. **Playback**: Holt Stream‑Links aus dem Plugin und startet die Wiedergabe.
|
||||
4. **Playstate**: Speichert Resume‑Daten lokal (`playstate.json`) und setzt `playcount`/Resume‑Infos.
|
||||
## Ablauf
|
||||
1. Plugin Discovery fuer `addon/plugins/*.py` ohne `_` Prefix.
|
||||
2. Navigation fuer Titel, Staffeln und Episoden.
|
||||
3. Playback: Link holen, optional aufloesen, abspielen.
|
||||
4. Playstate: watched und resume in `playstate.json` schreiben.
|
||||
|
||||
## Routing & Aktionen
|
||||
Die Datei arbeitet mit URL‑Parametern (Kodi‑Plugin‑Standard). Typische Aktionen:
|
||||
- `search` → Suche über ein Plugin
|
||||
- `seasons` → Staffeln für einen Titel
|
||||
- `episodes` → Episoden für eine Staffel
|
||||
- `play` → Stream‑Link auflösen und abspielen
|
||||
## Routing
|
||||
Der Router liest Query Parameter aus `sys.argv[2]`.
|
||||
Typische Aktionen:
|
||||
- `search`
|
||||
- `seasons`
|
||||
- `episodes`
|
||||
- `play_episode`
|
||||
- `play_movie`
|
||||
- `play_episode_url`
|
||||
|
||||
Die genaue Aktion wird aus den Query‑Parametern gelesen und an das entsprechende Plugin delegiert.
|
||||
## Playstate
|
||||
- Speicherort: Addon Profilordner, Datei `playstate.json`
|
||||
- Key: Plugin + Titel + Staffel + Episode
|
||||
- Werte: watched, playcount, resume_position, resume_total
|
||||
|
||||
## Playstate (Resume/Watched)
|
||||
- **Speicherort**: `playstate.json` im Addon‑Profilordner.
|
||||
- **Key**: Kombination aus Plugin‑Name, Titel, Staffel, Episode.
|
||||
- **Verwendung**:
|
||||
- `playcount` wird gesetzt, wenn „gesehen“ markiert ist.
|
||||
- `resume_position`/`resume_total` werden gesetzt, wenn vorhanden.
|
||||
## Wichtige Helper
|
||||
- Plugin Loader und Discovery
|
||||
- UI Builder fuer ListItems
|
||||
- Playstate Load/Save/Merge
|
||||
- TMDB Merge mit Source Fallback
|
||||
|
||||
## Wichtige Hilfsfunktionen
|
||||
- **Plugin‑Loader**: findet & instanziiert Plugins.
|
||||
- **UI‑Helper**: setzt Content‑Type, baut Verzeichnisseinträge.
|
||||
- **Playstate‑Helper**: `_load_playstate`, `_save_playstate`, `_apply_playstate_to_info`.
|
||||
- **Metadata‑Merge**: Plugin‑Metadaten können TMDB übersteuern, TMDB dient als Fallback.
|
||||
## Fehlerverhalten
|
||||
- Importfehler pro Plugin werden isoliert behandelt.
|
||||
- Fehler in einem Plugin sollen das Addon nicht stoppen.
|
||||
- User bekommt kurze Fehlermeldungen in Kodi.
|
||||
|
||||
## Fehlerbehandlung
|
||||
- Plugin‑Importfehler werden isoliert behandelt, damit das Addon nicht komplett ausfällt.
|
||||
- Netzwerk‑Fehler werden in Plugins abgefangen, `default.py` sollte nur saubere Fehlermeldungen weitergeben.
|
||||
|
||||
## Debugging
|
||||
- Globale Debug‑Settings werden über `addon/resources/settings.xml` gesteuert.
|
||||
- Plugins loggen URLs/HTML optional (siehe jeweilige Plugin‑Doku).
|
||||
|
||||
## Änderungen & Erweiterungen
|
||||
Für neue Aktionen:
|
||||
1. Neue Aktion im Router registrieren.
|
||||
2. UI‑Einträge passend anlegen.
|
||||
3. Entsprechende Plugin‑Methode definieren oder erweitern.
|
||||
|
||||
## Hinweis zur Erstellung
|
||||
Teile dieser Dokumentation wurden KI‑gestützt erstellt und bei Bedarf manuell angepasst.
|
||||
## Erweiterung
|
||||
Fuer neue Aktion im Router:
|
||||
1. Action im `run()` Handler registrieren.
|
||||
2. ListItem mit passenden Parametern bauen.
|
||||
3. Zielmethode im Plugin bereitstellen.
|
||||
|
||||
Reference in New Issue
Block a user