Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Inviare alla libreria dei contenuti
Introduzione
Questo tutorial ha lo scopo di guidarti su come inviare i tuoi contenuti alla Godot Asset Library e condividerli con la community di Godot.
Come menzionato nel documento Utilizzo della libreria dei contenuti, per poter inviare contenuti all'AssetLib è necessario avere un account registrato e aver effettuato l'accesso.
Linee guida per l'invio
Prima di inviare il tuo contenuto, per favore assicurati che soddisfi tutti i requisiti e considera anche di seguire i consigli.
Requisiti
In generale, la maggior parte dei contenuti inviati alla libreria viene accettata. Tuttavia, affinché il tuo contenuto venga accettato, ci sono alcuni requisiti che deve soddisfare per essere approvato.
Il contenuto deve funzionare. Se il contenuto non funziona o non funziona nella versione di Godot specificata, verrà rifiutato.
Il contenuto deve avere un file .gitignore appropriato. È importante evitare che i dati ridondanti finiscano nel repository. Ecco un modello.
Nessun sotto-modulo, o qualsiasi sotto-modulo non deve essere essenziale. GitHub non include sotto-moduli nel file ZIP scaricato, quindi se il contenuto necessita del contenuto del sotto-modulo, il contenuto non funzionerà.
La licenza deve essere corretta. La licenza elencata nella libreria di risorse deve corrispondere alla licenza presente nel repository. Il repository DEVE avere un file di licenza, denominato "LICENSE" o "LICENSE.md". Questo file deve contenere il testo della licenza e una dichiarazione di copyright che includa l'anno (o gli anni) di pubblicazione e il titolare del copyright.
Utilizza un inglese corretto per il nome e la descrizione del tuo contenuto. Ciò include l'uso corretto delle maiuscole e l'uso di frasi complete nella descrizione. Puoi anche includere altre lingue, ma dovrebbe esserci almeno una versione in inglese.
Il link all'icona deve essere un link diretto. Per le icone ospitate su GitHub, il link deve iniziare con "raw.githubusercontent.com", non con "github.com".
Raccomandazioni
Queste cose non sono obbligatorie affinché il contenuto sia approvato, ma se seguite queste raccomandazioni, potete contribuire a rendere la libreria dei contenuti un posto migliore per tutti gli utenti.
Quando si creano contenuti che non sono progetti, è prassi comune inserire i file nella cartella addons/nome_risorsa/. In questo modo si evita che i file si scontrino con altri contenuti o con i file degli utenti che installano la risorsa. Questa cartella non verrà generata automaticamente quando un utente installa la risorsa.
Correggere o sopprimere tutti gli avvisi degli script. Il sistema di avvisi serve a identificare i problemi con il codice, ma chi usa il contenuto non ha bisogno di vederli.
Fate in modo che il vostro codice sia conforme alle guide di stile ufficiali. Avere uno stile coerente aiuta gli altri a leggere il codice e aiuta anche chi vuole contribuire al contenuto. Vedi: la Guida di stile di GDScript o la Guida di stile C#.
Se hai degli screenshot nel tuo repository, inseriscili in una sottocartella a parte e aggiungi un file .gdignore vuoto nella stessa cartella (nota: gd, non git). Ciò impedirà a Godot di importare i tuoi screenshot. Su Windows, apri un prompt dei comandi nella cartella del progetto ed esegui
type nul > .gdignoreper creare un file il cui nome inizia con un punto.Se il tuo contenuto è una libreria per lavorare con altri file, considera l'inclusione di un file di esempio nel contenuto.
Considera di aggiungere un file .gitattributes al tuo repository. Questo file permette di fornire istruzioni aggiuntive a Git, come specificare le terminazioni di riga, ed elencare i file non necessari per il funzionamento del contenuto tramite la direttiva
export-ignore. Questa direttiva rimuove tali file dal file ZIP risultante, impedendo che siano scaricati dagli utenti della libreria dei contenuti. Ecco alcuni esempi comuni di .gitattributes:# Normalize line endings for all files that Git considers text files. * text=auto eol=lf
# Normalize line endings for all files that Git considers text files. * text=auto eol=lf # Only include the addons folder when downloading from the Asset Library. /** export-ignore /addons !export-ignore /addons/** !export-ignore
Se stai inviando un'estensione, aggiungi una copia della licenza e del file readme nella cartella dell'estensione stessa. Questa è la cartella che gli utenti sono tenuti a conservare con il loro progetto, quindi una copia garantisce che abbiano sempre quei file a portata di mano (e li aiuta a rispettare i termini della licenza).
Nonostante la libreria dei contenuti consenta di utilizzare altri servizi oltre GitHub, considera di ospitare il codice sorgente dei tuoi contenuti su GitHub. Gli altri servizi potrebbero non funzionare in modo affidabile, e una bassa familiarità con il servizio potrebbe essere un ostacolo per i contribuenti.
Invio
Una volta effettuato l'accesso, potrai andare alla pagina "Invia contenuti" dell'AssetLib, che apparirà come riportato di seguito:

Anche se potrebbe sembrare molto (e scorrendo verso il basso c'è di più), ogni campo è descritto in termini di cosa bisogna inserire. Ciononostante, anche qui esamineremo cosa è richiesto nel modulo di invio.
- Nome del contenuto:
Il nome del tuo contenuto. Dovrebbe essere un titolo unico e descrittivo di ciò che è il tuo contenuto.
- Categoria:
La categoria a cui appartiene il tuo contenuto, che verrà mostrato nei risultati di ricerca. La categoria è suddivisa in Componenti aggiuntivi e Progetti. Nell'editor, i componenti di tipo Progetto (Modelli, Demo, Progetti) sono visualizzate solo quando l'AssetLib è visualizzata dal Gestore dei progetti, mentre i contenuti di tipo Componente aggiuntivo saranno visibili solo dall'interno di un progetto.
- Versione di Godot:
La versione del motore con cui funziona il contenuto. Al momento, non è possibile avere una singola voce di contenuto avente il download per più versioni del motore, quindi potrebbe essere necessario riinviare la risorsa più volte, con una voce per ogni versione di Godot supportata. Questo è particolarmente importante quando si gestiscono versioni principali del motore, come Godot 2.x e Godot 3.x.
- Versione:
Il numero di versione della risorsa. Sebbene tu sia libero di scegliere e utilizzare qualsiasi schema di versioning che preferisci, potresti utilizzare un sistema come SemVer se desideri che lo schema di versioning del tuo contenuto sia chiaro e coerente. Tieni presente che esiste anche un numero di versione interno, il quale viene incrementato ogni volta che l'URL di download del contenuto viene modificato o aggiornato.
- Host del repository:
Le risorse caricate sull'AssetLib non sono ospitate direttamente su di essa. Puntano invece a repository ospitati su provider Git di terze parti, come GitHub, GitLab o Bitbucket. È qui che puoi scegliere il provider da utilizzare per la tua risorsa, in modo che il sito possa calcolare il link finale per il download.
- URL del repository:
L'URL dei file/pagina web del tuo contenuto. Questo varierà in base alla scelta del provider, ma dovrebbe essere simile a https://github.com/<user>/<project>.
- URL di Issues:
L'URL dell'issue tracker del tuo contenuto. Ancora una volta, questo sarà diverso per ogni host del repository, ma probabilmente sarà simile a https://github.com/<user>/<project>/issues. Puoi lasciare vuoto questo campo se usi l'issue tracker del tuo provider e fa parte dello stesso repository.
- Commit di download:
Il commit del contenuto. Per esempio, b1d3172f89b86e52465a74f63a74ac84c491d3e1. Il sito calcola l'URL effettivo per il download da questo campo.
- URL dell'icona:
L'URL dell'icona del tuo contenuto (che sarà usata come miniatura nei risultati di ricerca nell'AssetLib e nella pagina del contenuto). Dovrebbe essere un'immagine in formato PNG o JPG.
L'icona deve essere quadrata (rapporto d'aspetto 1:1). Dovrebbe avere una risoluzione minima di 128×128 pixel.
Nota
Per le icone ospitate su GitHub, è necessario fornire gli URL nel formato https://raw.githubusercontent.com/<user>/<project>/<branch>/Icon.png.
- Licenza:
La licenza sotto la quale si sta distribuendo il contenuto. L'elenco include una varietà di licenze di software libero e open-source, come GPL (v2 e v3), MIT, BSD e Boost Software License. Puoi visitare ` OpenSource.org <https://opensource.org>`_ per una descrizione dettagliata di ciascuna delle licenze elencate.
- Descrizione:
Infine, è possibile usare il campo Description per ricapitolare il contenuto, le sue caratteristiche e il suo comportamento, un changelog, ecc. In futuro, la formattazione con Markdown sarà supportata, ma attualmente, l'unica opzione disponibile è il testo semplice.
Puoi anche includere fino a tre video e/o immagini come anteprime, che saranno mostrate in fondo alla pagina del contenuto. Usa la casella di spunta "Enable" su ciascuna delle caselle di invio delle anteprime per abilitarle.
- Tipo:
O un'immagine o un video.
- URL di immagine/YouTube:
O un link all'immagine, o un video, ospitato su YouTube.
- URL della miniatura:
Un URL di un'immagine che verrà utilizzata come miniatura per l'anteprima. Questa opzione verrà eventualmente rimossa, e le miniature verranno invece calcolate automaticamente.
Una volta finito, premi "Submit". Il tuo contenuto sarà inserito nella coda di revisione. Puoi controllare tutti i contenuti attualmente in attesa di revisione ` qui <https://godotengine.org/asset-library/asset/edit?&asset=-1>`_ . Il processo di approvazione è manuale e può richiedere fino a qualche giorno prima che il tuo contenuto venga accettato (o rifiutata), quindi sii paziente!
Sarai informato quando il tuo contenuto sarà esaminato. Se è stato rifiutato, ti verrà comunicato il motivo e sarai in grado di ripresentarlo con le modifiche appropriate.