為 Windows 進行編譯

系統需求

若要在 Windows 下進行編譯,需要滿足下列條件:

  • Visual Studio Community 2017 版或更新版本。建議使用 VS 2019。 請務必閱讀下方的「Visual Studio 安裝須知」,否則會需要重新執行或下載安裝程式。

  • 配有 GCC 的 MinGW-w64 可用來代替 Visual Studio。請確定有以 posix 執行緒模型來進行安裝或設定。

  • Python 3.5+

  • SCons 3.0 建置系統。若使用 Visual Studio 2019,則需要至少 SCons 3.1.1。

  • 可選 - yasm (用於最佳化 WebM SIMD)

備註

若有安裝 ``Scoop <https://scoop.sh/>`_ ,則可以通過下列指令來輕鬆安裝 MinGW 以及其他相依性套件:

scoop install gcc python scons yasm make

備註

若有安裝 MSYS2 ,則可以通過下列指令輕鬆安裝 MinGW 以及其他相依性套件:

pacman -S mingw-w64-x86_64-python3-pip \
    mingw-w64-x86_64-gcc mingw-w64-x86_64-yasm \
    mingw-w64-i686-python3-pip mingw-w64-i686-gcc \
    mingw-w64-i686-yasm make

必須於各個 MSYS2 MinGW 子系統的 Shell 中執行 pip install scons

也參考

有關配合 Godot 使用 SCons 的一般說明,請參考 建置系統簡介

設定 Python

首先必須先安裝 Python 3.5 或更新版本。請確定在 Python 安裝程式中有開啟將 Python 新增至 PATH 的選項。SCons 安裝程式應該會偵測並使用現有的 Python。

設定 SCons

若要安裝 SCons,請開啟命令提示字元並輸入下列指令。

python -m pip install scons

若要檢查是否有正確安裝 Python 與 SCons,可以在命令提示字元 (cmd.exe) 中輸入 python --versionscons --version

若上述指令執行失敗,請確定有在安裝 Python 後將 Python 加至 PATH 環境變數中,然後再試一次。要將 Python 加入 PATH 環境變數,可以再次執行 Python 安裝程式,並開啟將 Python 加至 PATH 的選項。

Visual Studio 安裝須知

若安裝的 Visual Studio 是 2017 或 2019,請確定有在工作流程列表中開啟 C++

若安裝的 Visual Studio 是 2015,請不要使用 自定 安裝,請選擇 自定 安裝,然後選擇語言為 C++

若已經安裝好 Visual Studio 卻沒有開啟 C++ 支援的話,請重新執行安裝程式。重新執行安裝程式時應該有一個 修改 按鈕。若從 新增或移除程式 中執行安裝程式則只會出現 修復 選項,修復選項無法用於安裝 C++ 工具。

下載 Godot 原始碼

Godot 的原始碼 放在 GitHub 上 。建議通過 Git 來下載 (Clone)。

本教學假設原始碼放置於 C:\godot 中。

警告

To prevent slowdowns caused by continuous virus scanning during compilation, add the Godot source folder to the list of exceptions in your antivirus software.

For Windows Defender, hit the Windows key, type "Windows Defender Settings" then hit Enter. Under Virus & threat protection, go to Virus & threat protection setting and scroll down to Exclusions. Click Add or remove exclusions then add the Godot source folder.

編譯

選擇編譯器

SCons will automatically find and use an existing Visual Studio installation. If you do not have Visual Studio installed, it will attempt to use MinGW instead. If you already have Visual Studio installed and want to use MinGW, pass use_mingw=yes to the SCons command line. Note that MSVC builds cannot be performed from the MSYS2 or MinGW shells. Use either cmd.exe or PowerShell instead.

在開發時,最好選擇使用 Visual Studio 編譯器,因為 Visual Studio 編譯器連結到 Godot 二進位檔的速度比 MinGW 快多了。但,MinGW 通過使用連結時期最佳化 (詳見下方),能產生更加最佳化的二進位檔,因此對於正式使用,MinGW 比起 Visual Studio 編譯器來得更好。

執行 SCons

開啟命令提示字元後,請 (使用 cd) 將目錄更改至 Godot 原始碼的根目錄,然後輸入:

C:\godot> scons platform=windows

可以指定要使用的 CPU 執行緒數量來加速建置過程:

C:\godot> scons -j6 platform=windows

一般來說,可以儘量使用與 CPU 核心數一樣多的執行緒數量來編譯 Godot。可以像下面這樣,配合任何 SCons 指令使用 -j 選項。

備註

當使用多個 CPU 執行緒進行編譯,SCons 可能會提示缺少 pywin32。可以安心地忽略這個警告。

若沒出現什麼問題的話,最後產生的二進位可執行檔會放置於 C:\godot\bin\ 中,檔名為 godot.windows.tools.32.exegodot.windows.tools.64.exe 。預設情況下,SCons 會使用與你的 CPU 相同的架構來建置二進位檔,但可以通過 bits=64bits=32 選項來複寫此一自動偵測。

該執行檔包含了完整的 Godot 遊戲引擎,並且不需任何相依性套件即可執行。執行這個檔案會開啟專案管理員。

備註

若是要為正式環境編譯 Godot,則可以通過加上 target=release_debug SCons 選項來讓最終產生的可執行檔更小且更快速。

If you are compiling Godot with MinGW, you can make the binary even smaller and faster by adding the SCons option use_lto=yes. As link-time optimization is a memory-intensive process, this will require about 7 GB of available RAM while compiling.

備註

若想在客製化建置上使用與 Godot 官方釋出版本不同的編輯器設定,可以通過在 bin/ 資料夾中建立檔名為 ._sc__sc_ 的檔案來開啟 Self-contained mode

使用 Visual Studio 或其他 IDE 來進行開發

在大多數專案中,通常只需要撰寫腳本就夠了,但若有需要以 C++ 開發模組或擴充引擎,則建議使用 IDE。

可以通過 SCons 來建立 Visual Studio 解決方案。要建立解決方案,請使用 vsproj=yes 參數來執行 SCons,如:

scons p=windows vsproj=yes

現在可以在 Visual Studio 解決方案中開啟 Godot 原始碼了,然後可以通過 Visual Studio 的 建置 按鈕來建置 Godot。

若需要編輯建置指令,則可以在「Godot」專案設定中的 NMAKE 工作表中找到該設定。SCons 是在該指令的最後呼叫的。若將設定弄壞了,可以從其他的建置選項中 (debug, release_debug, release) 或架構 (Win32/x64) 中複製指令過來,指令都是相同的。

從其他作業系統上為 Windows 進行交叉編譯

若你使用 Linux 或 macOS,則需要安裝 MinGW-w64 。MinGW-w64 通常會有 32 位元與 64 位元的版本。依據發行版不同,可能會有不同的套件名稱。下列為一些已知的套件名稱:

Arch Linux

從 AUR 安裝 mingw-w64-gcc

Debian / Ubuntu

apt install mingw-w64

Fedora

dnf install mingw64-gcc-c++ mingw64-winpthreads-static \
            mingw32-gcc-c++ mingw32-winpthreads-static

macOS

brew install mingw-w64

Mageia

urpmi mingw64-gcc-c++ mingw64-winpthreads-static \
      mingw32-gcc-c++ mingw32-winpthreads-static

在嘗試編譯前,SCons 會在 PATH 環境變數中檢查下列二進位檔:

i686-w64-mingw32-gcc
x86_64-w64-mingw32-gcc

若這些二進位檔沒有放在 PATH 中 (如 /usr/bin) ,則必須定義下列變數來讓建置系統找到:

export MINGW32_PREFIX="/path/to/i686-w64-mingw32-"
export MINGW64_PREFIX="/path/to/x86_64-w64-mingw32-"

若要確定是否有正確設定,可以通過在 Shell 中執行下列指令來確認是否有可使用的編譯器 (輸出的版本可能會依據不同系統而有所不同):

${MINGW32_PREFIX}gcc --version
# i686-w64-mingw32-gcc (GCC) 6.1.0 20160427 (Mageia MinGW 6.1.0-1.mga6)

疑難排解

在某些 Ubuntu 版本中進行交叉編譯可能會出現 這個 Bug ,這是因為預設的設定未包含 POSIX 執行緒支援。

可以通過如下說明來更改此一設定。64 位元:

sudo update-alternatives --config x86_64-w64-mingw32-gcc
<choose x86_64-w64-mingw32-gcc-posix from the list>
sudo update-alternatives --config x86_64-w64-mingw32-g++
<choose x86_64-w64-mingw32-g++-posix from the list>

32 位元:

sudo update-alternatives --config i686-w64-mingw32-gcc
<choose i686-w64-mingw32-gcc-posix from the list>
sudo update-alternatives --config i686-w64-mingw32-g++
<choose i686-w64-mingw32-g++-posix from the list>

建立 Windows 匯出樣板

可以通過編譯不含編輯器的 Godot 來建立 Windows 匯出樣板。請使用下列旗標:

C:\godot> scons platform=windows tools=no target=release_debug bits=32
C:\godot> scons platform=windows tools=no target=release bits=32
C:\godot> scons platform=windows tools=no target=release_debug bits=64
C:\godot> scons platform=windows tools=no target=release bits=64

若之後有準備要取代標準匯出樣板,請將這些檔案複製到下列位置。請將其中的 <version> 改為版本識別項 (如 3.1.1.stable3.2.dev):

%USERPROFILE%\AppData\Roaming\Godot\templates\<version>\

並改為下列名稱:

windows_32_debug.exe
windows_32_release.exe
windows_64_debug.exe
windows_64_release.exe

但是,如果使用自定模組或自定引擎原始碼,則可能會需要在此將自定二進位檔設為自定匯出樣板:

../../_images/wintemplates.png

這種情況下則不需要複製檔案,只需要將產生的檔案參照進 Godot 原始碼資料夾的 bin\ 目錄中即可。這樣一來,下次進行建置時,便會自動參照自定樣板。