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'Asset Library, 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.

  • The asset must work. If the asset doesn't run or otherwise doesn't work in the specified Godot version, then it will be rejected.

  • The asset must have a proper .gitignore file. It's important to keep redundant data out of the repository. Here's a template.

  • No submodules, or any submodules must be non-essential. GitHub does not include submodules in the downloaded ZIP file, so if the asset needs the contents of the submodule, your asset won't work.

  • The license needs to be correct. The license listed on the asset library must match the license in the repository. The repo MUST have a license file, called either "LICENSE" or "LICENSE.md". This file must contain the license text itself and a copyright statement that includes the year(s) and copyright holder.

  • Use proper English for the name and description of your asset. This includes using correct capitalization, and using full sentences in the description. You can also include other languages, but there should at least be an English version.

  • The icon link must be a direct link. For icons hosted on GitHub, the link must start with "raw.githubusercontent.com", not "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.

  • Fix or suppress all script warnings. The warning system is there to help identify issues with your code, but people using your asset don't need to see them.

  • Make your code conform to the official style guides. Having a consistent style helps other people read your code, and it also helps if other people wish to contribute to your asset. See: the Guide de style GDScript or the Guide de style C#.

  • Si vous avez des captures d'écran dans votre repo, placez-les dans leur propre sous-dossier et ajoutez un fichier .gdignore dans le même dossier (note : gd, pas git). Cela empêche Godot d'importer vos captures d'écran. Sous Windows, ouvrez une invite de commande dans le dossier du projet et lancez type nul > .gdignore pour créer un fichier dont le nom commence par un point.

  • If your asset is a library for working with other files, consider including example files in the asset.

  • Consider adding a .gitattributes file to your repo. This file allows giving extra instructions to Git, such as specifying line endings and listing files not required for your asset to function with the export-ignore directive. This directive removes such files from the resulting ZIP file and prevents them from being downloaded by the asset library users. For a typical plugin .gitattributes may look like this:

    # Normalize EOL for all files that Git considers text files.
    * text=auto eol=lf
    
    # Ignore some files when exporting to a ZIP.
    /.gitattributes     export-ignore
    /.gitignore         export-ignore
    /LICENSE            export-ignore
    /LICENSE.md         export-ignore
    /README.md          export-ignore
    /project.godot      export-ignore
    /icon.png           export-ignore
    /icon.svg           export-ignore
    

    Other types of assets may require a different configuration (e.g. a project template requires project.godot).

  • If you are submitting a plugin, add a copy of your license and readme to the plugin folder itself. This is the folder that users are guaranteed to keep with their project, so a copy ensures they always have those files handy (and helps them fulfill your licensing terms).

  • The icon should be a square, its aspect ratio should be 1:1. It should also ideally have a minimum resolution of 64x64 pixels.

  • While the asset library allows more than just GitHub, consider hosting your asset's source code on GitHub. Other services may not work reliably, and a lack of familiarity can be a barrier to contributors.

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.