Soumettre à la bibliothèque d'asset

Introduction

Ce tutoriel a pour but de vous guider sur la manière de soumettre vos propres assets à la bibliothèque d'asset de Godot et de les partager avec la communauté de Godot.

Comme mentionné dans le document Utilisation de l'AssetLib, pour pouvoir soumettre des assets à l'AssetLib, vous devez avoir un compte enregistré, et être connecté.

Directives de soumission

Avant de soumettre votre asset, assurez vous qu’il respecte toutes les exigences et pensez à suivre les recommendations.

Pré-requis

En général, la plupart des assets soumis à la librairie d’assets sont acceptés. Cependant, pour que votre asset soit accepté, il y a quelques exigences que votre asset doit respecter.

  • L’asset doit fonctionner. Si l’asset ne se lance pas ou qu’il ne marche pas dans la version spécifiée de Godot, alors il sera rejeté.
  • L'asset doit avoir un fichier .gitignore approprié. Il est important d'éviter les données redondantes dans le dépôt. Voici un modèle.
  • Aucun sous-module, ou tout sous-modules doit être non essentiel. GitHub n’inclut pas de sous-modules dans le fichier ZIP téléchargé, donc si l’asset a besoin du contenu du sous-module, votre asset ne fonctionnera pas.
  • La licence doit être correcte. La licence affichée dans la librairie d’assets doit coïncider avec celle du dépôt.
  • Utilisez un Anglais propre pour le nom et la description de votre asset. Cela inclut l’utilisation d’une capitalisation correcte et de phrases complètes pour la description.
  • Le lien de l'icône doit être un lien direct. Pour les icônes hébergées sur GitHub, le lien doit commencer par "raw.githubusercontent.com", et non par "github.com".

Recommandations

Ces choses ne sont pas requises pour que votre asset soit approuvé, mais si vous suivez ces recommandations, vous pouvez contribuer à faire de la librairie d’assets un meilleur endroit pour tout utilisateur.

  • Corrigez ou supprimez tous les avertissements de script. Le système d'avertissement est là pour vous aider à identifier les problèmes liés à votre code, mais les personnes qui utilisent votre asset n'ont pas besoin de les voir.
  • Faites en sorte que votre code soit conforme aux guides de style officiels. Un style cohérent aide les autres personnes à lire votre code, et il est également utile si d'autres personnes souhaitent contribuer à votre asset. Voir : le Guide de style GDScript ou le Guide de style C#.
  • If you have screenshots in your repo, place them in their own subfolder and add a .gdignore file in the same folder (note: gd, not git). This prevents Godot from importing your screenshots. On Windows, open a command prompt in the project folder and run type nul > .gdignore to create a file whose name starts with a period.
  • Si votre asset est une librairie qui fonctionne avec d’autres fichiers, pensez à inclure des fichiers examples dans votre asset.
  • L'icône doit être un carré, son rapport d'aspect doit être de 1:1. Idéalement, elle devrait également avoir une résolution minimale de 64x64 pixels.
  • Bien que la bibliothèque d'assets permette plus que GitHub, pensez à héberger le code source de votre asset sur GitHub. D'autres services peuvent ne pas fonctionner de manière fiable, et un manque de familiarité peut constituer un obstacle pour les contributeurs.

Soumettre

Une fois connecté, vous pourrez vous rendre sur la page "Submit Assets" de l'AssetLib, qui ressemblera à ceci :

image0

Bien que cela puisse sembler beaucoup (et il y en a encore plus à mesure que vous faites défiler la page), chaque champ est décrit en termes de ce que vous devez y mettre. Nous allons néanmoins revoir ici aussi ce qui est requis dans le formulaire de soumission.

  • Asset Name :
    Le nom de votre asset. Il doit s'agir d'un titre unique et descriptif de votre asset.
  • Category :
    La catégorie à laquelle appartient votre asset, et qui apparaîtra dans les résultats de la recherche. La catégorie est divisée en Addons et Projects. Dans l'éditeur, les assets de type Project (Modèles, Démos, Projets) n'apparaissent que lorsque le gestionnaire de projet consulte l'AssetLib, tandis que les assets de type Addon ne sont visibles qu'à l'intérieur d'un projet.
  • Godot version :
    La version du moteur avec lequel l'asset fonctionne. Actuellement, il n'est pas possible de faire en sorte qu'une seule entrée d'asset contienne des téléchargements pour plusieurs versions de moteur, il vous faudra donc peut-être soumettre l'asset plusieurs fois, avec une entrée pour chaque version de Godot qu'il prend en charge. Cela est particulièrement important lorsqu'il s'agit de versions majeures du moteur, comme Godot 2.x et Godot 3.x.
  • Version :
    Le numéro de version de l'asset. Bien que vous soyez libre de choisir et d'utiliser le système de gestion des versions que vous souhaitez, vous pouvez vous pencher sur un système tel que SemVer si vous souhaitez que le système de gestion des versions de votre asset soit clair et cohérent. Notez qu'il existe également un numéro de version interne, incrémenté chaque fois que l'URL de téléchargement de l'asset est modifiée ou mise à jour.
  • Repository host :
    Les assets téléchargés sur l'AssetLib ne sont pas hébergés directement sur celui-ci. Ils pointent plutôt vers des dépôts hébergés sur des fournisseurs Git tiers, tels que GitHub, GitLab ou Bitbucket. C'est là que vous choisissez le fournisseur que votre asset utilise, afin que le site puisse calculer le lien de téléchargement final.
  • Repository URL :
    L'URL des fichiers/de la page web de votre asset. Cela variera en fonction de votre choix de fournisseur, mais cela devrait ressembler à https://github.com/<user>/<project>.
  • Issues URL :
    L'URL de l'outil de suivi des problèmes de votre asset. Encore une fois, ce sera différent d'un hôte de dépôt à l'autre, mais ressemblera probablement à https://github.com/<utilisateur>/<projet>/questions. Vous pouvez laisser ce champ vide si vous utilisez l'outil de suivi des problèmes de votre fournisseur, et s'il fait partie du même dépôt.
  • Download Commit :
    Le commit de l'asset. Par exemple, b1d3172f89b86e52465a74f63a74ac84c491d3e1. Le site calcule l'URL de téléchargement réel à partir de cette information.
  • Icon URL :
    L'URL de l'icône de votre asset (qui sera utilisée comme une vignette dans les résultats de recherche d'AssetLib et sur la page de l'asset). Il doit s'agir d'une image au format PNG ou JPG.
  • License :
    La licence sous laquelle vous distribuez l'asset. La liste comprend une variété de licences de logiciels libres et open-source, comme la GPL (v2 et v3), le MIT, le BSD et la Boost Software License. Vous pouvez visiter le site OpenSource.org pour une description détaillée de chacune des licences énumérées.
  • Description :
    Enfin, vous pouvez utiliser le champ Description pour obtenir un aperçu textuel de votre asset, de ses caractéristiques et de son comportement, un journal des modifications, etc. À l'avenir, le formatage avec Markdown sera pris en charge, mais actuellement, votre seule option est le texte en clair.

Vous pouvez également inclure jusqu'à trois vidéos et/ou images en avant-première, qui seront affichées en bas de la page de l'asset. Utilisez la case à cocher "Enable" sur chacune des cases de soumission de l'aperçu pour les activer.

  • Type :
    Soit une image, soit une vidéo.
  • Image/YouTube URL :
    Soit un lien vers l'image, soit vers une vidéo, hébergée sur YouTube.
  • Thumbnail URL :
    Une URL vers une image qui sera utilisée comme vignette pour l'aperçu. Cette option sera supprimée à terme et les vignettes seront calculées automatiquement à la place.

Une fois que vous avez terminé, cliquez sur Submit. Votre asset sera inscrit dans la file d'attente, que vous pouvez consulter sur la AssetLib ici . Le processus d'approbation est manuel et peut prendre jusqu'à quelques jours pour que votre addon soit accepté (ou rejeté), alors soyez patient ! Vous serez informé quand votre asset sera examiné. S'il a été rejeté, on vous expliquera pourquoi et vous pourrez le soumettre à nouveau avec les modifications appropriées. Vous aurez peut-être la chance d'accélérer le processus d'approbation en envoyant un message aux modérateurs/examinateurs d'assets sur IRC (le canal #godotengine-atelier sur Freenode), ou sur le serveur Discord officiel.