提交资源到资源馆

简介

本教程旨在指导你如何向Godot资产库提交自己的资产并与Godot社区分享.

正如 使用资产库 文档中提到的, 为了能够向AssetLib提交资源, 您需要有一个注册的帐户, 并且需要登录.

提交指南

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

需求

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

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

建议

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

  • 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 GDScript 风格指南 or the C# 风格指南.

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

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

提交

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

image0

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

  • 资源的名称 :

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

  • 分类 :

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

  • Godot 版本 :

    该资产适用的引擎版本. 目前, 不可能让一个资产条目包含多个引擎版本的下载, 所以你可能需要多次提交资产, 为其支持的每个Godot版本添加一个条目. 在处理主要的引擎版本时, 这一点尤其重要, 如Godot 2.x和Godot 3.x.

  • 版本 :

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

  • 存储库主机 :

    上传到AssetLib的资产并不直接托管在它上面. 而是, 它们指向托管在第三方Git提供商, 如GitHub, GitLab或Bitbucket上的仓库. 在这里你可以选择你的资产使用哪个提供商, 这样网站就可以计算出最终的下载链接.

  • 存储库地址 :

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

  • 问题地址 :

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

  • 下载提交 :

    该资产的提交. 例如, b1d3172f89b86e52465a74f63a74ac84c491d3e1 . 网站以此计算出实际的下载URL.

  • 图标地址 :

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

  • 许可证 :

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

  • 描述 :

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

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

  • 类型 :

    图像或视频.

  • 图片/ YouTube的网址 :

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

  • 缩略图地址 :

    一个图片的URL, 它将被用作预览的缩略图. 这个选项最终将被删除, 而缩略图将被自动计算出来.

完成后, 点击提交. 你的资产将进入待定队列, 你可以在AssetLib here 上访问. 审批流程是手动的, 可能需要几天的时间来接受(或拒绝)你的附加组件, 所以请耐心等待, 当你的资产被审查时, 你会被告知. 如果它被拒绝了, 你会被告知为什么会这样, 并且你将能够在做了适当的修改后再次提交它. 你可以在IRC(Freenode上的 #godotengine-atelier 频道)或官方Discord服务器上给版主/assetlib审查员发消息, 从而加快审批流程.