bozza struttura addon

mac12m99
2021-01-18 18:09:29 +01:00
parent b2387b4b16
commit e54a2e00c7

56
Struttura.md Normal file

@@ -0,0 +1,56 @@
# Struttura interna dell'addon
Quello che segue è un elenco delle cartelle e dei file principali dell'addon con una breve descrizione:
## channels/
Contiene tutti gli [scraper](https://it.wikipedia.org/wiki/Web_scraping#Web_scraper) dei canali supportati (cineblog01, ilgenio ecc..).<br>
Ogni canale ha 2 file: un .json che ne definisce le proprietà (nome, tipologia di contenuti ecc..) e un file .py che contiene il codice vero e proprio
## core/
Contiene tutte le funzioni chiave dell'addon che sono indispensabili al suo funzionamento e su cui si basano tutti gli scraper.
## lib/
Librerie esterne, questo percorso viene inserito nel PYTHONPATH.<br>
## platformcode/
Tutte le funzioni chiave che servono per interagire con la piattaforma Kodi.<br>
Nel caso venga fatto il porting su altre piattaforme, tutto il codice che le riguarda va inserito qui a sostituzione di quello attuale.
## resources/
[cartella necessaria a Kodi](https://kodi.wiki/view/Add-on_structure#resources.2F), contiene testi, immagini, le impostazioni di default e alcuni file xml che definiscono le finestre personalizzate
## servers/
Tutti gli [scraper](https://it.wikipedia.org/wiki/Web_scraping#Web_scraper) dei server supportati, come in channels ci sono 2 file: un .json per le proprietà e un .py per il codice.
## specials/
Sezioni dell'addon che non sono ne canali ne server (ad esempio la sezione aiuto).
## tests/
Test automatici delle funzionalità e degli scraper dell'addon.
## tools/
Script e file che non fanno parte dell'addon in se ma vengono usati esternamente (ad esempio, updateDomains.py viene usato nelle [actions di github](https://github.com/kodiondemand/addon/actions)).
## addon.xml
https://kodi.wiki/view/Add-on_structure#addon.xml
## channels.json
Contiene gli URL dei canali, è diviso in 2 chiavi:
- direct: link diretti
- findhost: link ai siti che pubblicano i nuovi indirizzi per i canali (di solito quelli che cambiano spesso)
## channelselector.py
Responsabile del menu iniziale, offre delle funzioni per filtrare i canali in base alla tipologia
## default.py
l'entry point: qualsiasi chiamata kodi farà all'addon, passerà sempre da qui.
## default_channel_settings.json
Ogni canale può avere dei settaggi riguardo all'essere inserito o nella ricerca globale, nelle novità ecc..
Questo file contiene i settaggi predefiniti.
## service.py
Servizio sempre attivo che effettua alcune operazioni periodiche come l'aggiornamento dell'addon e della videoteca.
## updatetvshow.py
Viene eseguito quando, dal menu di Kodi sezione serie tv, viene selezionata l'opzione "Cerca nuovi episodi".