Complete documentation: bilingual MkDocs Material site (EN default, IT)

.gitignore

@@ -152,6 +152,7 @@ venv.bak/
 
 # mkdocs documentation
 /site
+docs/site/
 
 # mypy
 .mypy_cache/

README.rst

@@ -78,7 +78,9 @@ RUN
 DOC
 ===
 
-Commands list `Unit3Dup <https://31december99.github.io/Unit3Dup/commands/>`_
+Full documentation `Unit3Dup Docs <https://31december99.github.io/Unit3Dup/>`_
+
+Commands list `Unit3Dup <https://31december99.github.io/Unit3Dup/reference/commands/>`_
 
 
 ImageHost

docs/docs/config/clients.it.md

@@ -0,0 +1,68 @@
+# Client torrent
+
+Sezione `torrent_client_config` di `Unit3Dbot.json`. Dopo l'upload il bot consegna il torrent al tuo client per il **seeding**.
+
+## Scegli il client
+
+```json
+"TORRENT_CLIENT": "qbittorrent",
+```
+
+Valori possibili: `qbittorrent`, `transmission`, `rtorrent`.
+
+Il client è **obbligatorio** per qualsiasi operazione di upload con seeding (`-u`, `-f`, `-scan`, `-watcher`, `-reseed`): all'avvio il bot testa la connessione e, se fallisce o il nome non è valido, esce con `Unknown Torrent Client name` o errore di connessione.
+
+!!! tip "Niente client?"
+    Con `-noseed` (upload senza seeding) o `-noup` (crea solo il `.torrent`) il client non viene contattato.
+
+## qBittorrent
+
+```json
+"QBIT_USER": "admin",
+"QBIT_PASS": "la_tua_password",
+"QBIT_HOST": "127.0.0.1",
+"QBIT_PORT": "8080",
+"SHARED_QBIT_PATH": "no_path",
+```
+
+Credenziali della **WebUI** (in qBittorrent: *Strumenti → Opzioni → WebUI*). `QBIT_HOST` accetta l'IP della macchina dove gira il client.
+
+## Transmission
+
+```json
+"TRASM_USER": "admin",
+"TRASM_PASS": "la_tua_password",
+"TRASM_HOST": "127.0.0.1",
+"TRASM_PORT": "9091",
+"SHARED_TRASM_PATH": "no_path",
+```
+
+## rTorrent
+
+```json
+"RTORR_USER": "admin",
+"RTORR_PASS": "la_tua_password",
+"RTORR_HOST": "127.0.0.1",
+"RTORR_PORT": "9091",
+"SHARED_RTORR_PATH": "no_path",
+```
+
+## SHARED_*_PATH — client su un'altra macchina
+
+Se il client torrent gira su una macchina, un container o un OS **diverso** da quello dove lanci il bot, i percorsi locali dei tuoi file non coincidono con quelli visti dal client.
+
+`SHARED_*_PATH` è il percorso **come lo vede il client**: il bot lo usa al posto del percorso locale quando registra il torrent per il seeding.
+
+Esempio — bot su Windows, qBittorrent in un container che monta la stessa cartella su `/downloads`:
+
+```json
+"SHARED_QBIT_PATH": "/downloads",
+```
+
+## TAG
+
+```json
+"TAG": "ADDED TORRENTS",
+```
+
+Etichetta/categoria applicata ai torrent aggiunti dal bot nel client: utile per riconoscerli e filtrarli.

docs/docs/config/clients.md

@@ -0,0 +1,68 @@
+# Torrent clients
+
+`torrent_client_config` section of `Unit3Dbot.json`. After the upload, the bot hands the torrent to your client for **seeding**.
+
+## Pick your client
+
+```json
+"TORRENT_CLIENT": "qbittorrent",
+```
+
+Allowed values: `qbittorrent`, `transmission`, `rtorrent`.
+
+The client is **required** for any upload with seeding (`-u`, `-f`, `-scan`, `-watcher`, `-reseed`): on startup the bot tests the connection and exits with `Unknown Torrent Client name` or a connection error if something is wrong.
+
+!!! tip "No client?"
+    With `-noseed` (upload without seeding) or `-noup` (create the `.torrent` only) the client is never contacted.
+
+## qBittorrent
+
+```json
+"QBIT_USER": "admin",
+"QBIT_PASS": "your_password",
+"QBIT_HOST": "127.0.0.1",
+"QBIT_PORT": "8080",
+"SHARED_QBIT_PATH": "no_path",
+```
+
+**WebUI** credentials (in qBittorrent: *Tools → Options → WebUI*). `QBIT_HOST` takes the IP of the machine running the client.
+
+## Transmission
+
+```json
+"TRASM_USER": "admin",
+"TRASM_PASS": "your_password",
+"TRASM_HOST": "127.0.0.1",
+"TRASM_PORT": "9091",
+"SHARED_TRASM_PATH": "no_path",
+```
+
+## rTorrent
+
+```json
+"RTORR_USER": "admin",
+"RTORR_PASS": "your_password",
+"RTORR_HOST": "127.0.0.1",
+"RTORR_PORT": "9091",
+"SHARED_RTORR_PATH": "no_path",
+```
+
+## SHARED_*_PATH — client on another machine
+
+If your torrent client runs on a **different** machine, container or OS than the one running the bot, your local file paths won't match what the client sees.
+
+`SHARED_*_PATH` is the path **as seen by the client**: the bot uses it instead of the local path when registering the torrent for seeding.
+
+Example — bot on Windows, qBittorrent in a container mounting the same folder at `/downloads`:
+
+```json
+"SHARED_QBIT_PATH": "/downloads",
+```
+
+## TAG
+
+```json
+"TAG": "ADDED TORRENTS",
+```
+
+Label/category applied to the torrents the bot adds to the client: handy to spot and filter them.

docs/docs/config/imagehosts.it.md

@@ -0,0 +1,43 @@
+# Image host
+
+Il bot estrae gli screenshot dal video e li carica su un servizio di hosting immagini; gli URL finiscono nella descrizione del torrent. Le chiavi stanno in `tracker_config`, le priorità in `user_preferences`.
+
+## Host supportati
+
+| Host | Sito | Chiave |
+|---|---|---|
+| PtScreens | [ptscreens.com](https://ptscreens.com) | `PTSCREENS_KEY` |
+| LensDump | [lensdump.com](https://lensdump.com) | `LENSDUMP_KEY` |
+| FreeImage | [freeimage.host](https://freeimage.host) | `FREE_IMAGE_KEY` |
+| ImgBB | [imgbb.com](https://imgbb.com) | `IMGBB_KEY` |
+| ImgFI | [imgfi.com](https://imgfi.com) | `IMGFI_KEY` |
+| PassIMA | [passtheima.ge](https://passtheima.ge) | `PASSIMA_KEY` |
+| ImaRide | [imageride.net](https://www.imageride.net) | `IMARIDE_KEY` |
+
+Per ogni host: registrati sul sito, genera la API key, incollala in `Unit3Dbot.json`:
+
+```json
+"IMGBB_KEY": "la_tua_chiave",
+"FREE_IMAGE_KEY": "la_tua_chiave",
+```
+
+!!! tip "Quanti host configurare?"
+    Non è obbligatorio usarli tutti, ma **configurane almeno due**: se l'upload su un host fallisce, il bot passa automaticamente al successivo.
+
+## Priorità e fallback
+
+In `user_preferences` ogni host ha una priorità — **0 = primo tentativo**:
+
+```json
+"PTSCREENS_PRIORITY": 0,
+"LENSDUMP_PRIORITY": 1,
+"FREE_IMAGE_PRIORITY": 2,
+"IMGBB_PRIORITY": 3,
+"IMGFI_PRIORITY": 4,
+"PASSIMA_PRIORITY": 5,
+"IMARIDE_PRIORITY": 6,
+```
+
+Il bot tenta gli host in ordine di priorità crescente; al primo errore (chiave non valida, servizio giù, limite raggiunto) passa al successivo.
+
+Le opzioni sugli screenshot (`NUMBER_OF_SCREENSHOTS`, compressione, resize, webp) sono nelle [Opzioni avanzate](options.md).