JetBrains Rider

JetBrains RiderJetBrains 提供的商業級 C# 與 C++ IDE,與 Visual Studio 採用相同解決方案(solution)系統。

備註

此文件說明如何以 Rider 參與引擎開發,不是用來設定 C# 或 GDScript 編輯器。如果你想用外部編輯器撰寫 C# 或 GDScript,請見 C# 外部編輯器設定教學

匯入專案

你需要在開發環境安裝好 PythonMinGW,還有 Visual Studio 的 C++ Build Tools(可用 Visual Studio Installer 安裝)。請確認所有相依工具都已安裝完畢再繼續。

小訣竅

如果你已使用 Visual Studio 作為主要 IDE,可以直接用同一個 solution 檔在 Rider 開啟。Rider 與 Visual Studio 的 solution 格式相容,兩者切換無須重建解決方案。但 IDE 間切換時需重新設定偵錯參數。

Rider 需要 solution 檔才能開發 C++ 專案。雖然 Godot 沒有附 solution 檔,但可用 SCons 產生。

  • 前往 Godot 根目錄並開啟命令提示字元或 PowerShell 視窗。

  • 複製、貼上並執行下列指令以產生 solution。

scons platform=windows vsproj=yes dev_build=yes

vsproj 參數代表要產生 Visual Studio solution,dev_build 會包含偵錯符號,讓你能逐步除錯。

  • 如果你已將 Rider 設為 .sln 的預設 IDE,現在可以直接在專案根目錄雙擊 godot.sln 開啟,或在 Rider 內選擇 Open 開啟。

備註

若 Rider 無法建置 solution,請嘗試執行 git clean -xdf 移除所有先前的建置產物,再用 scons 重新產生 solution。必要時也可重啟終端機與 IDE。

編譯與除錯專案

Rider 內建偵錯器,可用於除錯 Godot。點畫面上方的 Debug 圖示即可啟動偵錯(預設僅針對專案管理員),若要除錯 Godot 編輯器,需先進行偵錯設定。

../../../_images/rider_run_debug.webp
  • 點畫面頂端 Godot > Edit Configurations 進行設定。

../../../_images/rider_configurations.webp
  • 請確認 C++ 專案執行設定如下:

    • Exe Path:$(LocalDebuggerCommand)

    • Program Arguments:-e --path <Godot 專案路徑>

    • Working Directory:$(LocalDebuggerWorkingDirectory)

    • Before Launch 設為「Build Project」

這樣啟動時會直接除錯你指定的專案而不會經過專案管理員。請填入專案資料夾的根路徑,不是 project.godot 檔案路徑。

../../../_images/rider_configurations_changed.webp
  • 最後點選「Apply」與「OK」儲存設定。

  • 之後你只要按頂端的 Debug 圖示,Rider 就會用偵錯器啟動 Godot 編輯器。

你也可以用 Run > Attach to Process 將偵錯器附加到已啟動的 Godot 程序。

../../../_images/rider_attach_to_process.webp
  • 你可以搜尋 godot.editor 找到執行中的 Godot 實例,然後點擊 Attach with LLDB 附加偵錯

../../../_images/rider_attach_to_process_dialog.webp

如需 JetBrains IDE 進階資訊,請參考 JetBrains Rider 官方文件