X11のコンパイル (Linux、*BSD)

参考

This page describes how to compile Linux editor and export template binaries from source. If you're looking to export your project to Linux instead, read Exporting for Linux.

必要条件

Linux またはその他の Unix バリアントでコンパイルするには、次のことが必要です:

  • GCC 7以降 または Clang 6以降。

  • Python 3.5 以降。

  • SCons 3.0+ build system. If your distribution uses Python 2 by default, or you are using a version of SCons prior to 3.1.2, you will need to change the version of Python that SCons uses by changing the shebang (the first line) of the SCons script file to #! /usr/bin/python3. Use the command which scons to find the location of the SCons script file.

  • pkg-config (以下の依存関係を検出するために使用)。

  • X11、Xcursor、Xinerama、XiおよびXRandR開発用ライブラリ。

  • MesaGL開発用ライブラリ。

  • ALSA開発用ライブラリ。

  • PulseAudio開発用ライブラリ。

  • 任意 - libudev (udev=yes でのビルドに)。

  • 任意 - yasm (WebM SIMD最適化のため)。

参考

To get the Godot source code for compiling, see ソースの取得.

Godotにおける基本的なSconsの使い方については、ビルドシステムの説明を参照してください。

ディストリビューション固有のワンライナー

Alpine Linux

 
apk add scons pkgconf gcc g++ libx11-dev libxcursor-dev libxinerama-dev libxi-dev libxrandr-dev \
    mesa-dev libexecinfo-dev eudev-dev alsa-lib-dev pulseaudio-dev

Arch Linux

 
pacman -S --needed scons pkgconf gcc libxcursor libxinerama libxi libxrandr mesa glu libglvnd \
    alsa-lib pulseaudio yasm

Debian / Ubuntu

 
sudo apt-get install build-essential scons pkg-config libx11-dev libxcursor-dev libxinerama-dev \
    libgl1-mesa-dev libglu-dev libasound2-dev libpulse-dev libudev-dev libxi-dev libxrandr-dev yasm

Fedora

 
sudo dnf install scons pkgconfig libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel \
    libXi-devel mesa-libGL-devel mesa-libGLU-devel alsa-lib-devel pulseaudio-libs-devel \
    libudev-devel yasm gcc-c++ libstdc++-static libatomic-static

FreeBSD

 
sudo pkg install py37-scons pkgconf xorg-libraries libXcursor libXrandr libXi xorgproto libGLU \
    alsa-lib pulseaudio yasm

Gentoo

 
emerge -an dev-util/scons x11-libs/libX11 x11-libs/libXcursor x11-libs/libXinerama x11-libs/libXi \
    media-libs/mesa media-libs/glu media-libs/alsa-lib media-sound/pulseaudio dev-lang/yasm

Mageia

 
urpmi scons task-c++-devel pkgconfig "pkgconfig(alsa)" "pkgconfig(glu)" "pkgconfig(libpulse)" \
    "pkgconfig(udev)" "pkgconfig(x11)" "pkgconfig(xcursor)" "pkgconfig(xinerama)" "pkgconfig(xi)" \
    "pkgconfig(xrandr)" yasm

OpenBSD

 
pkg_add python scons llvm yasm

openSUSE

 
sudo zypper install scons pkgconfig libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel \
        libXi-devel Mesa-libGL-devel alsa-devel libpulse-devel libudev-devel libGLU1 yasm

NetBSD

 
pkg_add pkg-config py37-scons yasm

For audio support, you can optionally install pulseaudio.

Solus

 
sudo eopkg install -c system.devel scons libxcursor-devel libxinerama-devel libxi-devel \
    libxrandr-devel mesalib-devel libglu alsa-lib-devel pulseaudio-devel yasm

コンパイル

ターミナルを起動し、エンジンソースコードのルートディレクトリに移動し、次のように入力します:

scons -j8 platform=x11

-j (jobs ジョブ) フラグに関する経験則は、GodotのコンパイルにはCPUのコア数だけスレッドを割り当てるべきということです。そこからさらに一つか二つ追加してもいいでしょう。下記にあるSConsコマンドのいずれにも自由に -j オプションを付けてください。

すべてがうまくいけば、結果として得られるバイナリ実行可能ファイルは「bin」サブディレクトリに配置されます。この実行可能ファイルにはエンジン全体が含まれており、依存関係なしで実行されます。実行すると、プロジェクトマネージャが呼び出されます。

注釈

GCCではなくClangを使用してコンパイルする場合は、次のコマンドを使用します:

scons platform=x11 use_llvm=yes

Clangを使うことはOpenBSDの要件のようで、そうしないとフォントが作れません。

注釈

制作に使うGodotをコンパイルするなら、SConsのオプション target=release_debug を追加すれば、より小さくて高速な実行ファイルにすることができます。

If you are compiling Godot with GCC, 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.

注釈

If you want to use separate editor settings for your own Godot builds and official releases, you can enable 自己完結型モード by creating a file called ._sc_ or _sc_ in the bin/ folder.

Compiling a headless/server build

To compile a headless build which provides editor functionality to export projects in an automated manner, use:

scons -j8 platform=server tools=yes target=release_debug

To compile a debug server build which can be used with remote debugging tools, use:

scons -j8 platform=server tools=no target=release_debug

To compile a server build which is optimized to run dedicated game servers, use:

scons -j8 platform=server tools=no target=release

エクスポートテンプレートの構築

警告

Linuxのバイナリは通常、ビルドしたディストリビューションより古いディストリビューションでは動きません。もし大抵のディストリビューションで動作するバイナリを配布したいなら、Ubuntu 16.04のような古いディストリビューションでビルドするべきでしょう。バーチャルマシンやコンテナを使えば、適切なビルド環境をセットアップできます。

X11(Linux、*BSD)エクスポートテンプレートをビルドするには、次のパラメーターを使用してビルド システムを実行します:

  • (32ビット)

scons platform=x11 tools=no target=release bits=32
scons platform=x11 tools=no target=release_debug bits=32

  • (64ビット)

scons platform=x11 tools=no target=release bits=64
scons platform=x11 tools=no target=release_debug bits=64

注意点として、現在のホスト プラットフォームの反対のビット(64/32)へのクロスコンパイルは、簡単にいくとは限らず、chroot環境が必要になるかもしれません。

標準のエクスポート テンプレートを作成するには、結果のファイルを次の場所にコピーする必要があります:

$HOME/.local/share/godot/templates/[gd-version]/

そして、このように命名されます (Godotでは*BSD の場合も「Linux X11」と見なされます):

linux_x11_32_debug
linux_x11_32_release
linux_x11_64_debug
linux_x11_64_release

ただし、カスタムモジュールまたはカスタムC++ コードを作成する場合は、ここでカスタムエクスポート テンプレートとしてバイナリを構成する必要があります:

../../_images/lintemplates.png

この場合はコピーする必要はなく、Godotのソースフォルダ内にある bin\ ディレクトリに出力されたファイルを指定するだけです。こうすれば、次にビルドした時も、自動的にカスタム テンプレートを参照するようになります。

ClangとLLDを使用して開発を高速化する

ClangとLLDを使用してGodotを構築することもできます。これには、デフォルトのGCC + GNU ldセットアップと比較して2つの利点があります:

  • LLDは、GNU ldまたはgoldと比較してGodotを大幅に高速にリンクします。これにより、反復時間が短縮されます。

  • Clangは、GCCよりも有用なエラーメッセージを提供する傾向があります。

これを行うには、ディストリビューションのパッケージマネージャーからClangと lld パッケージをインストールし、次のSConsコマンドを使用します:

scons platform=x11 use_llvm=yes use_lld=yes

After the build is completed, a new binary with a .llvm suffix will be created in the bin/ folder.

リンク時最適化を使用してコンパイルし、結果のバイナリをより小さく、より高速にすることができるため、プロダクションビルドにはGCCを使用することをお勧めします。

Using Pyston for faster development

You can use Pyston to run SCons. Pyston is a JIT-enabled implementation of the Python language (which SCons is written in). It is currently only compatible with Linux. Pyston can speed up incremental builds significantly, often by a factor between 1.5× and 2×. Pyston can be combined with Clang and LLD to get even faster builds.

  • Download the latest portable Pyston release.

  • Extract the portable .tar.gz to a set location, such as $HOME/.local/opt/pyston/ (create folders as needed).

  • Use cd to reach the extracted Pyston folder from a terminal, then run ./pyston -m pip install scons to install SCons within Pyston.

  • To make SCons via Pyston easier to run, create a symbolic link of its wrapper script to a location in your PATH environment variable:

    ln -s ~/.local/opt/pyston/bin/scons ~/.local/bin/pyston-scons

  • Instead of running scons <build arguments>, run pyston-scons <build arguments> to compile Godot.

If you can't run pyston-scons after creating the symbolic link, make sure $HOME/.local/bin/ is part of your user's PATH environment variable.