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...
編輯器圖示
當你建立新類別並讓它可用於腳本時,編輯器介面預設會以該類別所繼承的基底類別圖示顯示。絕大多數情況下,仍建議為新類別設計專屬圖示,以提升使用者體驗。
建立圖示
要建立新圖示,請先安裝向量繪圖軟體,例如開源的 Inkscape。
將包含所有編輯器圖示的 godot 儲存庫複製到本地端:
git clone https://github.com/godotengine/godot.git
圖示必須使用矢量圖形編輯器以 SVG 格式建立。需要遵循以下三個主要要求:
圖示尺寸必須為 16×16。於 Inkscape 可透過「檔案 > 文件屬性」設定大小。
線條應儘量吸附至像素,以便在低 DPI 下維持清晰。可於 Inkscape 開啟 16×16 格線協助對齊。
若使用者將編輯器設定為亮色主題,Godot 會根據 一組預設色彩對應 自動轉換圖示顏色,以確保有足夠對比。請盡量將圖示的色票限制在上述清單中的色彩,否則圖示在亮色背景下可能會難以辨識。
完成圖示設計後,將檔案儲存至剛才複製的儲存庫的 editor/icons 目錄下,檔名須符合預期類別名稱且區分大小寫。例如要為 CPUParticles2D 建立圖示,檔名應為 CPUParticles2D.svg。
小訣竅
你也可以在 Godot 編輯器圖示 網站上瀏覽所有現有的圖示。
自訂圖示的匯入選項
對於專案中自帶的自訂圖示(而不是引擎原始碼里自帶的那些),你應該啟用以下兩個匯入選項:
高解析度(hiDPI)螢幕的縮放適配
圖示需要在高解析度(hiDPI)顯示器上進行適當的縮放,以確保它們依然保持清晰,並且足夠大、易於閱讀。
為了確保圖示在高解析度(hiDPI)顯示器上能以正確的比例渲染,請在檔案系統(FileSystem)面板中選中該 SVG 檔案,然後在匯入(Import)面板中啟用 Editor > Scale with Editor Scale (編輯器 > 隨編輯器縮放)選項,最後點擊 按鈕。請注意,該選項僅適用於 SVG 格式的圖示,因為它必須相依性矢量格式才能生效。
亮色主題下的圖示色彩轉換
為了確保當使用者使用亮色主題(light theme)時,圖示的顏色能正確地進行轉換適配,請在檔案系統(FileSystem)面板中選中該 SVG 檔案,然後在匯入(Import)面板中啟用 Editor > Convert Colors with Editor Theme (編輯器 > 隨編輯器主題轉換顏色)選項,最後點擊 按鈕。請注意,該選項僅適用於 SVG 格式的圖示,因為它必須相依性矢量格式才能生效。
圖示最佳化
由於編輯器會在載入時算繪一次 SVG,因此檔案應保持精簡,以便有效率地解析。當 pre-commit hook 執行時,會自動使用 svgo 最佳化 SVG。
備註
最佳化步驟不會明顯影響圖示品質,但會移除如輔助線等僅供編輯時用的資訊。因此,若需日後修改,建議保留原始 SVG 檔。
整合與分享圖示
若你要貢獻至 Godot 本體,請發送 Pull Request,將最佳化後的圖示加入主儲存庫的 editor/icons 目錄。重新編譯引擎後,新類別的圖示就會自動套用。
你也可以於自製模組中建立專屬的自訂圖示。如果該模組不打算整合進 Godot 主專案,則無需額外發送 Pull Request,自訂圖示會在模組內自動生效。
關於如何建立模組圖示的具體說明,請參閱:Creating custom module icons。
疑難排解
若圖示未出現在編輯器中,請檢查:
每個圖示的檔名有無遵循上述命名規範。
svg模組必須在編譯時開啟(預設情況下它是開啟的)。如果沒有這個模組,圖示就完全無法在編輯器中顯示。