Рекомендации
Прежде чем предоставлять свой ресурс, убедитесь, что он соответствует всем требованиям, и также рассмотрите возможность следования рекомендациям.
Требования
В общем, большинство ресурсов, которые люди предоставляют в библиотеку ресурсов, принимаются. Тем не менее, чтобы ваш ресурс был принят, необходимо, чтобы он соответствовал нескольким требованиям.
- Ассет должен работать. Если ресурс не запускается или по какой-то другой причине не работает в указанной версии Godot, он будет отклонен.
- У ресурса должен быть правильный файл .gitignore. Важно избегать избыточных данных в репозитории.
- Отсутствие подмодулей или все подмодули должны быть необязательными. GitHub не включает подмодули в загруженный ZIP-файл, поэтому, если ресурсу нужны содержимое подмодуля, ваш ресурс не будет работать.
- Лицензия должна быть корректной. Лицензия, указанная в библиотеке ресурсов, должна соответствовать лицензии в репозитории. У репозитория ДОЛЖЕН быть файл лицензии, названный либо «LICENSE», либо «LICENSE.md». В этом файле должен содержаться сам текст лицензии и заявление об авторском праве, которое включает год(ы) и владельца авторских прав.
- Используйте правильный английский для названия и описания вашего ассета. Это включает в себя правильное использование заглавных букв и полные предложения в описании. Вы также можете добавить другие языки, но должна быть хотя бы английская версия.
- Иконка должна являться прямой ссылкой. Для иконок, размещенных на GitHub, ссылка должна начинаться с «raw.githubusercontent.com», а не с «github.com».
Рекомендации
Это необязательные шаги, чтобы Ваши ресурсы приняли, но если Вы выполните следующие рекомендации, Вы поможете сделать библиотеку ресурсов лучше.
- При создании ресурсов, не являющихся проектами, общепринято размещать файлы внутри папки addons/название_ресурса/. Сделайте это, чтобы избежать конфликтов ваших файлов с другими ресурсами или файлами пользователей, устанавливающих ваш ресурс. Эта папка не будет автоматически создаваться при установке вашего ассета пользователем.
- Устраните или скройте все предупреждения скрипта. Система предупреждений помогает выявить проблемы в Вашем коде, но людям, пользующимся Вашими ресурсами, не нужно их видеть.
- Соблюдайте официальные стандарты стиля кода. Согласованный стиль помогает другим людям читать ваш код, и это также полезно, если другие люди хотят внести свой вклад в ваш ресурс.
- Если у Вас в архиве есть скриншоты, поместите их в собственную подпапку и добавьте пустой файл .gdignore в ту же самую папку (примечание: gd, а не git). Это предотвратит Godot от импорта ваших скриншотов. На Windows откройте командную строку в папке проекта и запустите
type nul > .gdignore, чтобы создать файл, название которого начинается с точки. - Если ваш ресурс представляет собой библиотеку для работы с другими файлами, рассмотрите возможность включения примерных файлов в ресурс.
- Рассмотрите возможность добавления файла .gitattributes в ваш репозиторий. Этот файл позволяет давать дополнительные инструкции Git, такие как указание символов конца строки и перечисление файлов, необходимых для функционирования вашего ресурса с использованием директивы export-ignore. Эта директива удаляет такие файлы из результирующего ZIP-файла, предотвращая их загрузку пользователями библиотеки ресурсов. Вот общие примеры .gitattributes:
# Normalize line endings for all files that Git considers text files.
* text=auto eol=lf- Если вы предоставляете плагин, добавьте копию вашей лицензии и файла readme в саму папку плагина. Это та папка, которую пользователи гарантированно будут хранить в своем проекте, поэтому копия гарантирует, что у них всегда будут эти файлы под рукой (и помогает им соблюдать условия вашей лицензии).
- Хотя библиотека ресурсов поддерживает не только GitHub, рассмотрите возможность размещения исходного кода вашего ресурса на GitHub. Другие сервисы могут работать ненадежно и незнание их может быть барьером для потенциальных участников.
Предоставление
Когда вы вошли в систему, вы сможете перейти на страницу «Предоставить ресурсы» в AssetLib, которая будет выглядеть так:
Хотя это может выглядеть много (и есть еще больше при прокрутке вниз), каждое поле описано в терминах того, что вам следует ввести. Тем не менее мы также рассмотрим, что требуется в форме предоставления здесь.
Название ресурса: Название вашего ресурса. Должно быть уникальным, описательным заголовком, отражающим характер вашего ресурса.
Категория: Категория, к которой принадлежит ваш ресурс и которая будет отображаться в результатах поиска. Категория разделена на Аддоны и Проекты. В редакторе ресурсы типа Проект (Шаблоны, Демо, Проекты) появляются только при просмотре AssetLib из Менеджера проектов, в то время как ресурсы типа Аддон будут видны только изнутри проекта.
Версия Godot: Версия движка, с которой совместим ваш ресурс. В настоящее время невозможно включить в одну запись ресурса загрузки для нескольких версий движка, поэтому, возможно, вам придется предоставить ресурс несколько раз, с записью для каждой поддерживаемой версии Godot. Это особенно важно при работе с основными версиями движка, такими как Godot 2.x и Godot 3.x.
Версия: Номер версии asset. Хотя вы свободны выбирать и использовать любую систему версионирования, которую предпочитаете, вам, возможно, стоит обратить внимание на что-то вроде SemVer, если вы хотите, чтобы схема версионирования вашего ресурса была понятной и последовательной. Обратите внимание, что также есть внутренний номер версии, увеличиваемый каждый раз, когда изменяется или обновляется URL для скачивания ресурса.
Хост репозитория: Ресурсы, загружаемые в AssetLib, не хранятся в нем напрямую. Вместо этого они указывают на репозитории, размещенные на сторонних провайдерах Git, таких как GitHub, GitLab или Bitbucket. Здесь вы выбираете, какой провайдер использует ваш ресурс, чтобы сайт мог вычислить окончательную ссылку для скачивания.
URL репозитория: URL к файлам/веб-странице вашего ресурса. Это будет зависеть от вашего выбора провайдера, но должно выглядеть примерно так: https://github.com/<пользователь>/<проект>.
URL проблем: URL к asset’s issue tracker. Опять же, он будет различаться от хоста репозитория, но, вероятно, будет похоже на https://github.com/<пользователь>/<проект>/issues. Вы можете оставить это поле пустым, если используете трекер проблем вашего провайдера и он является частью того же репозитория.
Коммит для скачивания: Коммит ресурса. Например, b1d3172f89b86e52465a74f63a74ac84c491d3e1. Сайт вычисляет фактический URL для скачивания из этого коммита.
URL иконки: URL к иконке вашего ресурса (которая будет использоваться в качестве миниатюры в результатах поиска AssetLib и на странице ресурса). Должно быть изображение в формате PNG или JPG.
Иконка должна быть квадратной (с соотношением сторон 1:1). Минимальное разрешение должно составлять 128×128 пикселей.
Лицензия: Лицензия, по которой распространяется ваш ресурс. В список включены различные лицензии свободного и открытого программного обеспечения, такие как GPL (v2 и v3), MIT, BSD и Boost Software License. Вы можете посетить OpenSource.org для подробного описания каждой из перечисленных лицензий.
Описание: Наконец, вы можете использовать поле «Описание» для текстового обзора вашего ресурса, его функций и поведения, списка изменений и так далее. В будущем будет поддерживаться форматирование с использованием Markdown, но на данный момент вашим единственным вариантом является обычный текст.
Вы также можете добавить до трех видео- и/или изображений, которые будут отображаться внизу страницы ресурса. Используйте флажок «Включить» в каждом из окон для предпросмотра, чтобы включить их.
Тип: Либо изображение, либо видео.
Image/YouTube URL: Ссылка на изображение или видео, размещенное на YouTube.
Thumbnail URL: URL изображения, которое будет использоваться в качестве миниатюры для предпросмотра. Эта опция будет удалена в конечном итоге, и миниатюры будут вычисляться автоматически.
После завершения нажмите «Отправить». Ваш ресурс будет добавлен в очередь на рассмотрение. Вы можете проверить все ресурсы, находящиеся в настоящее время в ожидании рассмотрения здесь. Процесс утверждения выполняется вручную и может занять несколько дней, прежде чем ваш ресурс будет принят (или отклонен), поэтому будьте терпеливы!
Вы будете проинформированы, когда ваш актив будет проверен. Если он был отклонен, вам сообщат, почему это могло произойти, и вы сможете отправить его снова с соответствующими изменениями.