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

Submitting to the Asset Store

Введение

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.

Рекомендации по подаче заявок

Прежде чем отправлять свой материал, убедитесь, что он соответствует всем требованиям, а также рассмотрите возможность соблюдения рекомендаций.

Требования

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.

  • Ресурс должен работать. Если ресурс не запускается или иным образом не работает в указанной версии Godot, он будет отклонен.

  • Ресурс должен иметь корректный файл .gitignore. Важно не допускать попадания избыточных данных в репозиторий. Вот шаблон.

  • Никаких submodules или подмодулей, которые не являются необходимыми. GitHub не включает подмодули в загружаемый ZIP-файл, поэтому, если для актива требуется содержимое подмодуля, ваш asset не будет работать.

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

  • Используйте правильный Английский для имени и описания вашего ассета. Это включает использование прописной первой буквы, и использование полных предложений в описании. Вы можете также использовать другие языки, но Английская версия должна быть.

  • Иконка должна являться прямой ссылкой. Для иконок, размещенных на GitHub, ссылка должна начинаться с "raw.githubusercontent.com", а не с "github.com".

Рекомендации

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.

  • При создании ресурсов, не связанных с проектом, обычной практикой является размещение ваших файлов внутри папки ** addons /asset_name / ** . Сделайте это, чтобы избежать столкновения ваших файлов с другими ресурсами или с файлами пользователей, устанавливающих ваш ресурс. Эта папка не будет автоматически создаваться при установке пользователем вашего ресурса.

  • Устраните или скройте все предупреждения скрипта. Система предупреждений помогает выявить проблемы в Вашем коде, но людям, пользующимся Вашими ресурсами, не нужно их видеть.

  • 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 Руководство по стилю GDScript or the Руководство по стилю 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.

  • Если ваш ресурс представляет собой библиотеку для работы с другими файлами, рассмотрите возможность включения в ресурс файлов-примеров.

  • 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

  • Если Вы отправляете плагин, добавьте копию Вашей лицензии и readme-файла в саму папку плагина. Пользователи смогут хранить эту папку вместе с их проектами, таким образом копия гарантирует, что эти файлы всегда будут у них под рукой (и помогает им выполнить Ваши лицензионные требования).

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

Предоставление

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

Обзор

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.

Настройки

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

  • Asset Summary

  • Detailed description

  • Теги

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

Версии

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.