Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

提交資源到素材庫

前言

本教學旨在指導你如何向 `Godot 素材庫 <https://godotengine.org/asset-library/asset>`_提交自己的素材並與 Godot 社區分享。

正如 素材庫 文件中提到的, 為了能夠向AssetLib提交資源, 您需要有一個註冊的帳戶, 並且需要登錄.

提交規範

在提交您的資源之前, 請確保您的資源符合所有要求, 並考慮遵循規範建議.

系統需求

一般來說, 人們提交給資源庫的大部分資源都會被接受. 然而, 為了使您的資源被接受, 資源需要滿足一些要求才能被批准.

  • 素材必須是**有效的**。如果該素材無法工作或在指定的 Godot 版本中不能工作,那麼它將被拒絕。

  • 該素材必須擁有合適的 .gitignore 檔案。把多餘的資料從版本庫中剔除是很重要的。這裡有一個範本。

  • 不使用**子模組**,或者所有子模組都必須是非必要的。GitHub 下載的 ZIP 檔中不包括子模組,所以如果你的素材需要用到子模組中的內容,將無法使用。

  • 許可證 license 需是正確。素材庫中列出的許可證必須與版本庫中的許可證一致。版本庫需要有一個授權檔案,稱為 "LICENSE" 或 "LICENSE.md" 。這個檔必須包含許可證文字本身和版權宣告,包括年份和版權所有者。

  • 在你的素材名稱和描述中使用正確的**英語**。這包括使用正確的大寫字母,並在描述中使用完整的句子。你也可以包括其他語言,但至少應該有一個英文版本。

  • 圖示連結必須是一個 direct link 直接連結。對於託管在GitHub上的圖示,連結必須以 "raw.githubusercontent.com" 開頭,而不是 "github.com"。

建議

這些事情並不是你的資源被批准的必要條件, 但如果你遵循這些建議, 你可以幫助使資源庫成為所有使用者體驗更好的地方.

  • 建立非專案素材時,通常的做法是將檔放在 addons/asset_name/ 資料夾中。這樣做可以避免您的檔與其他素材或安裝了您的素材的使用者檔發生衝突。當使用者安裝您的素材時,此資料夾 不會 自動生成。

  • 修復或禁止所有腳本**警告**。警告系統可説明識別您的程式碼問題,但使用您的素材的人不需要看到它們。

  • 使你的程式碼符合官方的**風格指南**。有一致的風格有助於其他人閱讀你的程式碼,如果其他人希望為你的素材做貢獻,將會有幫助。請參閱 GDScript 風格指南C# 風格指南

  • 如果倉庫中有截圖,把它們放在子資料夾裡,並在該資料夾裡新增一個 .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的 copy 新增到外掛程式資料夾本身。這是保證使用者與他們的專案一起保留的資料夾,副本確保他們始終可以方便地使用這些檔,並幫助他們履行你的許可條款。

  • 雖然素材庫允許的不僅僅是 GitHub,但考慮將素材的原始程式碼託管在 GitHub。其他服務可能無法可靠地工作,而且不熟悉可能會成為貢獻者的障礙。

提交

一旦您登錄,您將能夠轉到 AssetLib 的“Submit Assets”(提交素材)頁面,該頁面如下所示:

image0

雖然它可能看起來很多(並且向下滾動時會顯示更多),每個欄位都是根據您應該放入的內容進行描述的。但是,我們仍堅持在這裡將提交表單中所需的內容詳細闡述一遍。

  • Asset Name

    您素材名稱。應該是您素材的特有描述性標題。

  • Category

    您的素材所屬的類別,將顯示在搜索結果中。該類別分為 **Addons**(外掛程式)和 **Projects**(專案)。在編輯器中,專案型別(範本、演示、專案)的素材將顯示在專案管理器的 AssetLib 中,而外掛程式型別的資源僅顯示在專案內部中。

  • Godot version

    該素材適用的引擎版本。目前,無法讓一個素材條目包含多個引擎版本的下載,所以你可能需要多次提交素材,為其支援的每個 Godot 版本新增一個條目。在處理主要的引擎版本時,這一點尤其重要,如 Godot 2.x 和 Godot 3.x。

  • Version

    素材的版本號。雖然您可以自由選擇和使用您喜歡的任何版本控制方案,但如果您希望素材的版本控制方案清晰且一致,您可能需要查看諸如 SemVer 之類的內容。請注意,系統內還有一個內部版本號,每次更改或更新資源下載位址時都會增加。

  • Repository host

    上傳到 AssetLib 的素材並不直接託管在它上面。而是指向 GitHub、GitLab、Bitbucket 等協力廠商 Git 提供商託管的倉庫。這就是你選擇素材所用提供商的地方,這樣網站就能據此計算出最終的下載連結。

  • Repository URL

    素材檔/網頁的 URL。這將根據您選擇的提供商而有所不同,但結構類似於 https://github.com/<使用者>/<專案>

  • Issues URL

    資源問題追蹤器的 URL。同樣,根據託管倉庫的不同而不同,但結構類似於 https://github.com/<使用者>/<專案>/issues。如果您使用提供商的問題追蹤器,則可以將此欄位留空,因為它是倉庫的一部分。

  • Download Commit

    該素材的提交號。例如,b1d3172f89b86e52465a74f63a74ac84c491d3e1。網站以此計算出實際的下載 URL。

  • Icon URL

    素材圖示的 URL(將在 AssetLib 搜索結果和素材頁面中用作縮略圖)。應該是 PNG 或 JPG 格式的圖像。

    icon 應為正方形,其縱橫比應為 1:1。它的最低解析度最好是64x64像素。

  • License

    您分發資源的許可證。該列表包括各種自由且開源軟體許可證,如 GPL (v2和v3)、MIT、BSD 和 Boost 軟體許可證。您可以存取 OpenSource.org 獲取每個列出的許可證的詳細說明。

  • Description

    最後, 您可以使用Description欄位來查看資源, 其功能和行為, 更改紀錄等文字概述. 將來, 將支援使用Markdown格式, 但目前只支援純文字.

您還可以包含最多三個影片和/或圖像預覽,這些預覽將顯示在資源頁面的底部。請使用每個預覽提交框上的“啟用”核取方塊從而啟用它們。

  • Type

    圖像或影片。

  • Image/YouTube URL

    圖像或託管在 YouTube 上的影片的連結。

  • Thumbnail URL

    圖片的 URL,這張圖片將用作預覽的縮略圖。這個選項最終將被刪除,縮略圖將被自動計算出來。

完成後點擊“Submit”。你的素材就會進入審核佇列。你可以在`這裡 <https://godotengine.org/asset-library/asset/edit?&asset=-1>`_查看所有正在等待審核的素材。審核過程是人工的,你的素材可能會花上若干天才能通過(或者駁回),請耐心等待!

備註

你可以在`貢獻者聊天室 <https://chat.godotengine.org/>`_或官方 Discord 伺服器中聯繫管理員和 AssetLib 審核員碰碰運氣看看能不能加速審核進度。

你的素材通過審核後會通知你。如果被駁回,會告知你相關原因,你可以在做出正確的修改後重新提交。