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.

Submitting to the Asset Store

Introduction

This tutorial aims to serve as a guide on how you can submit your own assets to the Godot Asset Store and share them with the Godot community.

As mentioned in the Using the Asset Store Website page, in order to be able to submit assets to the Asset Store, you need to have a registered account, and be logged in.

Directives de soumission

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

Pré-requis

Generally speaking, most assets people submit to the Asset Store are accepted. However, in order for your asset to be accepted, there are a few requirements it needs to meet to be approved.

  • 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.

  • The license needs to be correct. The license listed on the Asset Store must match the license in the repository. The repository 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.

  • 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. Vous pouvez également inclure d'autres langues, mais il doit y avoir au moins une version anglaise.

  • 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

These things are not required for your asset to be approved, but if you follow these recommendations, you can help make the asset store a better place for all users.

  • Lors de la création d'éléments non liés à un projet, il est courant de placer vos fichiers dans un dossier addons/asset_name/. Procédez ainsi pour éviter que vos fichiers n'entrent en conflit avec d'autres éléments ou avec les fichiers des utilisateurs qui installent votre élément. Ce dossier ne sera pas généré automatiquement lorsqu'un utilisateur installe votre élément.

  • 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.

  • 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#.

  • If you have screenshots in your repository, place them in their own subfolder and add an empty .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 exemples dans votre asset.

  • Consider adding a .gitattributes file to your repository. 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, preventing them from being downloaded by Asset Store users. These are common examples of .gitattributes:

    # Normalize line endings for all files that Git considers text files.
    * text=auto eol=lf
    
  • Si vous soumettez un plugin, ajoutez une copie de votre licence et de votre fichier readme dans le dossier du plugin lui-même. Il s'agit du dossier que les utilisateurs sont assurés de conserver avec leur projet. Une copie leur permet donc d'avoir toujours ces fichiers à portée de main (et les aide à respecter vos conditions de licence).

  • While the Asset Store 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

Once you are logged in, click on Upload Asset on the top right of the website. It will take you to the following page:

../../_images/asset_store_submit.webp

Here is a breakdown of each field:

  • Publisher: This is the public name associated with the asset. For example, the XR Tools asset has the publisher "Godot XR".

  • Publisher Name: The name of the new publisher you are creating.

  • Publisher URL Slug: how the publisher will appear in its link. For example, the XR Tools asset has the following URL: https://store.godotengine.org/asset/godot-xr/godot-xr-tools/

    The publisher URL Slug in that is "godot-xr".

  • Asset Name: The name of your asset. Should be a unique, descriptive title of what your asset is.

  • Asset URL: How the asset will be named in its link. For example, the XR Tools asset has the following URL: https://store.godotengine.org/asset/godot-xr/godot-xr-tools/

    The asset URL for that link is "godot-xr-tools".

After filling out those fields, agree to the terms of service after reading them, and click "Continue". You will be brought to the asset's management page, where you can edit almost everything about how it will appear on the store, as well as upload different versions.

../../_images/asset_store_management.webp

Management pages

Vue d'ensemble

The overview tab lets you submit your asset for review. You can also view analytics including how many times it's been downloaded, page visits, and the number of people who have added it to their library.

You can also delete the asset at the bottom of the page from this tab.

Paramètres

This tab is where you set up the following general information about your asset:

  • Asset Summary

  • Detailed description

  • Étiquettes

  • Asset type (Full Project or Addon)

  • License

  • Link to source code

  • AI usage disclosure (This is mandatory if you use AI)

Media

The media tab is where you upload your thumbnail, screenshots, an image for the featured page if you want, and link to a YouTube video if you have one.

Versions

This is where you upload the actual asset files. For each version you upload you can give it a name, write a changelog, and specify the minimum Godot version (and maximum if applicable). There is also an additional information field for anything miscellaneous.

Each individual version has a maximum file size of 1GB.

Pricing

While paid assets can't be uploaded yet, there are some settings relevant to free assets. You can link to another website where you accept donations, such as Patreon or Ko-Fi. You can also disable reviews if you want (in the future paid assets will not have this option).

Submitting for review

Once you are done, press "Submit". Your asset will be entered into the review queue. You will be informed when your asset is reviewed. If it was rejected, you will be told why that may have been, and you will be able to submit it again with the appropriate changes.