dev: bump to 0.1.76.0-dev – aeltere Versionen im Update-Dialog, Release-Branch-Zuordnung, README ueberarbeitet
This commit is contained in:
108
README.md
108
README.md
@@ -2,42 +2,86 @@
|
||||
|
||||
<img src="addon/resources/logo.png" alt="ViewIT Logo" width="220" />
|
||||
|
||||
ViewIT ist ein Kodi Addon.
|
||||
Es durchsucht Provider und startet Streams.
|
||||
**ViewIT** ist ein Kodi-Addon zum Streamen von Filmen und Serien aus verschiedenen Quellen – alles an einem Ort.
|
||||
|
||||
## Projektstruktur
|
||||
- `addon/` Kodi Addon Quellcode
|
||||
- `scripts/` Build Scripts
|
||||
- `dist/` Build Ausgaben
|
||||
- `docs/` Doku
|
||||
- `tests/` Tests
|
||||
## Was kann ViewIT?
|
||||
|
||||
## Build und Release
|
||||
- Addon Ordner bauen: `./scripts/build_install_addon.sh`
|
||||
- Kodi ZIP bauen: `./scripts/build_kodi_zip.sh`
|
||||
- Version pflegen: `addon/addon.xml`
|
||||
- Reproduzierbares ZIP: `SOURCE_DATE_EPOCH` optional setzen
|
||||
- **Filme und Serien** aus mehreren Streaming-Quellen durchsuchen und abspielen
|
||||
- **Trakt-Anbindung** – Watchlist, Weiterschauen, Watch-History und automatisches Scrobbling
|
||||
- **TMDB-Metadaten** – Poster, Beschreibungen, Bewertungen und Fanart automatisch laden
|
||||
- **Autoplay** – Bevorzugten Hoster einstellen und direkt abspielen
|
||||
- **Automatische Updates** – Neue Versionen werden erkannt und koennen direkt installiert werden
|
||||
|
||||
## Lokales Kodi Repository
|
||||
- Repository bauen: `./scripts/build_local_kodi_repo.sh`
|
||||
- Repository starten: `./scripts/serve_local_kodi_repo.sh`
|
||||
- Repo-Artefakte pruefen: `./scripts/verify_repo_artifacts.py ./dist/repo`
|
||||
- Standard URL: `http://127.0.0.1:8080/repo/addons.xml`
|
||||
- Eigene URL beim Build: `REPO_BASE_URL=http://<host>:<port>/repo ./scripts/build_local_kodi_repo.sh`
|
||||
## Installation
|
||||
|
||||
## Entwicklung
|
||||
- Router: `addon/default.py`
|
||||
- Plugins: `addon/plugins/*_plugin.py`
|
||||
- Settings: `addon/resources/settings.xml`
|
||||
1. Die neueste ZIP-Datei herunterladen (siehe [Releases](https://gitea.it-drui.de/viewit/ViewIT/releases))
|
||||
2. In Kodi: **Einstellungen** > **Addons** > **Aus ZIP-Datei installieren**
|
||||
3. Die heruntergeladene ZIP-Datei auswaehlen
|
||||
4. ViewIT erscheint unter **Video-Addons**
|
||||
|
||||
## Tests
|
||||
- Dev Pakete installieren: `./.venv/bin/pip install -r requirements-dev.txt`
|
||||
- Tests starten: `./.venv/bin/pytest`
|
||||
- XML Report: `./.venv/bin/pytest --cov-report=xml`
|
||||
### Updates
|
||||
|
||||
### Linting & Formatierung
|
||||
- Ruff Linting: `./.venv/bin/ruff check addon docs`
|
||||
- Black Format Check: `./.venv/bin/black --check addon docs`
|
||||
ViewIT kann sich selbst aktualisieren. In den Addon-Einstellungen unter **Updates** den gewuenschten Kanal waehlen:
|
||||
|
||||
## Dokumentation
|
||||
Siehe `docs/`.
|
||||
- **Main** – Stabile Versionen
|
||||
- **Nightly** – Aktuelle Entwicklungsversionen
|
||||
- **Dev** – Neueste Aenderungen (kann instabil sein)
|
||||
|
||||
## Einstellungen
|
||||
|
||||
Die wichtigsten Einstellungen im Addon:
|
||||
|
||||
- **Quellen** – Basis-URLs der einzelnen Streaming-Seiten (falls sich Domains aendern)
|
||||
- **Metadaten** – TMDB aktivieren/deaktivieren, Sprache einstellen
|
||||
- **Wiedergabe** – Autoplay und bevorzugten Hoster festlegen
|
||||
- **Trakt** – Konto verbinden fuer Watchlist und Scrobbling
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
- Kodi 19 (Matrix) oder neuer
|
||||
- **ResolveURL** – wird beim ersten Start automatisch installiert (kann auch manuell ueber die Einstellungen nachinstalliert werden)
|
||||
|
||||
## Fuer Entwickler
|
||||
|
||||
<details>
|
||||
<summary>Build und Projektstruktur</summary>
|
||||
|
||||
### Projektstruktur
|
||||
|
||||
```
|
||||
addon/ Kodi-Addon Quellcode
|
||||
default.py Hauptdatei und Router
|
||||
plugins/ Streaming-Plugins (eins pro Quelle)
|
||||
core/ Kernmodule (Trakt, Metadaten, Updates, ...)
|
||||
resources/ Einstellungen, Icons, Sprachdateien
|
||||
scripts/ Build- und Deploy-Skripte
|
||||
tests/ Automatisierte Tests
|
||||
dist/ Build-Ausgaben
|
||||
```
|
||||
|
||||
### Addon bauen
|
||||
|
||||
```bash
|
||||
# Addon-Ordner erzeugen
|
||||
bash scripts/build_install_addon.sh
|
||||
|
||||
# ZIP fuer Kodi-Installation erzeugen
|
||||
bash scripts/build_kodi_zip.sh
|
||||
```
|
||||
|
||||
### Tests ausfuehren
|
||||
|
||||
```bash
|
||||
pip install -r requirements-dev.txt
|
||||
pytest
|
||||
```
|
||||
|
||||
### Lokales Kodi-Repository
|
||||
|
||||
```bash
|
||||
bash scripts/build_local_kodi_repo.sh
|
||||
bash scripts/serve_local_kodi_repo.sh
|
||||
# Erreichbar unter http://127.0.0.1:8080/repo/addons.xml
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
Reference in New Issue
Block a user