提交资源到资源馆

简介

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

正如 Using the Asset Library 文档中提到的,为了能够向AssetLib提交资源,您需要有一个注册的帐户,并且需要登录。

提交指南

在提交您的资源之前,请确保您的资源符合所有要求,并考虑遵循规范建议。

需求

一般来说,人们提交给资源库的大部分资源都会被接受。然而,为了使您的资源被接受,资源需要满足一些要求才能被批准。

  • 该资产必须能运行,如果该资源在指定的Godot版本中无法运行或无法工作,那么它将被拒绝。

  • 资源必须有一个适合的**.gitignore**文件。重要的一点,不要把多余的数据放在仓库里。`这里有一个模板。<https://github.com/github/gitignore/blob/master/Godot.gitignore>`_

  • 没有子模块,或者所以子模块必须是非必要的。GitHub不会在下载的ZIP文件中包含子模块,所以如果资源需要子模块内容,你的资源将无法使用。

  • 许可证必须正确。资源库中列出的许可证必须与仓库中的许可证一致。仓库必须有一个许可证文件,叫做 "LICENSE "或 "LICENSE.md"。这个文件必须包含许可证文本本身和版权声明,包括年份和版权持有人。

  • 使用正确的英语来描述资源的名称和说明,这包括使用正确的大写字母,并在描述中使用完整的句子。

  • 图标链接必须是直接链接。对于GitHub上的图标,链接必须以 "raw.githubusercontent.com "开头,而不是 "github.com"。

Recommendations

这些事情并不是你的资源被批准的必要条件,但如果你遵循这些建议,你可以帮助使资源库成为所有用户体验更好的地方。

  • 修复或禁止所有脚本警告,警告的作用是帮助识别代码中的问题,但使用你的资源的人不需要看到它们。

  • 让代码符合官方的风格指南。拥有一致的风格有助于其他人阅读代码,也有助于其他人为资源做出贡献。参见: GDScript 风格指南C# 风格指南

  • 如果存储库里有截图,把它们放在子文件夹里,并在同一文件夹里添加一个**.gdignore**文件(注意:是**gd**,不是**git**),这样可以防止Godot导入截图。在Windows上,在项目文件夹中打开命令提示符,运行``type nul > .gdignore``来创建一个名字以句号开头的文件。

  • 如果你的资源是一个用于处理其他文件的库,请考虑在资源中加入示例文件。

  • 图标应为正方形,其长宽比应为1:1。 理想情况下,它的最小分辨率应为64x64像素。

  • 虽然资源库允许的不仅是GitHub,但请考虑将资源的源代码托管在GitHub上,其他服务可能不可靠,而且缺乏熟悉度可能会成为贡献者的障碍。

提交

一旦您登录,您将能够转到AssetLib的``提交资源``页面,该页面如下所示:

image0

虽然它可能看起来很多(并且向下滚动时会显示更多),每个字段都是根据您应该放入的内容进行描述的。但是,我们仍坚持在这里将提交表单中所需的内容详细阐述一遍。

  • 资源的名称:

    您的资源名称。 应该是您资源的特有描述性标题。

  • 分类:

    您的资源所属的类别,并将显示在搜索结果中。 该类别分为 插件项目 。 在编辑器中,项目类型(模板,演示,项目)的资源将显示在项目管理器的AssetLib中,而插件类型的资源仅显示在项目内部中。

  • Godot 版本:

    The version of the engine that the asset works with. Currently, it's not possible to have a single asset entry contain downloads for multiple engine versions, so you may need to re-submit the asset multiple times, with an entry for each Godot version it supports. This is particularly important when dealing with major versions of the engine, such as Godot 2.x and Godot 3.x.

  • 版本:

    资源的版本号。 虽然您可以自由选择和使用您喜欢的任何版本控制方案,但如果您希望资源的版本控制方案清晰且一致,您可能需要查看诸如 SemVer 之类的内容。 请注意,系统内还有一个内部版本号,每次更改或更新资源下载地址时都会增加。

  • 存储库主机:

    Assets uploaded to the AssetLib are not hosted on it directly. Instead, they point to repositories hosted on third-party Git providers, such as GitHub, GitLab or Bitbucket. This is where you choose which provider your asset uses, so the site can compute the final download link.

  • 存储库地址:

    资源文件/网页的地址。 这将根据您选择的提供商而有所不同,但它的结构类似于 https://github.com/<user>/<project>

  • 问题地址:

    资源问题跟踪器的地址。 同样,这将不同于存储库主机,但结构类似于 https://github.com/<user>/<project>/issues。 如果您使用提供商的问题跟踪器,则可以将此字段留空,因为它是资源存储库的一部分。

  • Download Commit:

    The commit of the asset. For example, b1d3172f89b86e52465a74f63a74ac84c491d3e1. The site computes the actual download URL from this.

  • 图标地址:

    资源图标的地址(将在AssetLib搜索结果和资源页面中用作缩略图)。 应该是PNG或JPG格式的图像。

  • 许可证:

    您分发资源的许可证。 该列表包括各种免费和开源软件许可证,例如GPL(v2和v3),MIT,BSD和Boost软件许可证。 您可以访问 OpenSource.org 获取每个列出的许可证的详细说明。

  • 描述:

    最后,您可以使用Description字段来查看资源,其功能和行为,更改日志等文本概述。 将来,将支持使用Markdown格式,但目前只支持纯文本。

您还可以包含最多三个视频和/或图像预览,这些预览将显示在资源页面的底部。 请使用每个预览提交框上的``启用``复选框从而启用它们。

  • 类型:

    图像或视频。

  • 图片/ YouTube的网址:

    YouTube上托管的图片或视频链接。

  • 缩略图地址:

    A URL to an image that will be used as a thumbnail for the preview. This option will be removed eventually, and thumbnails will be automatically computed instead.

Once you are done, hit Submit. Your asset will be entered into the pending queue, which you can visit on the AssetLib here . The approval process is manual and may take up to a few days for your addon to be accepted (or rejected), so please be patient! 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. You may have some luck accelerating the approval process by messaging the moderators/assetlib reviewers on IRC (the #godotengine-atelier channel on Freenode), or the official Discord server.