Install

インストール

Desktop Environment

デスクトップ環境

Ebiten requires X Window system and you need to install a window manager like GNOME3. See the official manual. Note that you also need to do pkg install xorg.

Ebiten を動かすためには X Window system が必要です。 GNOME3 のようなウィンドウマネージャをインストールする必要があります。公式マニュアルを参照してください。 pkg install xorg を実行する必要があることに注意してください。

Go

Install Go on your machine. Ebiten requires Go 1.12 or later.

Go をインストールしてください。 Ebiten を動かすためには Go 1.12 以降が必要です。

Note that you do NOT need a C compiler for Ebiten on Windows.

Windows では、 C コンパイラは必要ありません。

C compiler

C コンパイラ

A C compiler is required as Ebiten uses not only Go but also C.

Ebiten は Go だけではなく C も使っているため、 C コンパイラが必要になります。

On the latest macOS, just type clang on your terminal and a dialog would appear if you don't have clang compiler. Follow the instruction to install it.

最新の macOS ならば、ターミナル上で clang と入力すれば、 clang がまだインストールされていないのであれば、ダイアログが表示されます。指示に従ってインストールしてください。

You might find the following error when executing clang.

clang 実行中に次のようなエラーメッセージが表示されるかもしれません。

xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun

In this case, run xcode-select --install and install commandline tools.

その場合は xcode-select --install を実行して、コマンドラインツールをインストールしてください。

Use your distribution's package manager. For example, Ubuntu can use apt.

お使いのディストリビューションのパッケージマネージャを使ってください。例えば、 Ubuntu では apt が使えます。

apt install gcc

Use pkg.

pkg を使ってください。

pkg install clang

You need to set some environment variables.

いくつか環境変数を設定する必要があります。

export C_INCLUDE_PATH=/usr/local/include:${C_INCLUDE_PATH}
export CPLUS_INCLUDE_PATH=/usr/local/include:${CPLUS_INCLUDE_PATH}
export LIBRARY_PATH=/usr/local/lib:${LIBRARY_PATH}

Dependencies

依存ライブラリ

Debian / Ubuntu

sudo apt install libc6-dev libglu1-mesa-dev libgl1-mesa-dev libxrandr-dev libxcursor-dev libxinerama-dev libxi-dev libasound2-dev

Fedora

sudo dnf install mesa-libGLU-devel mesa-libGLES-devel libXrandr-devel libXcursor-devel libXinerama-devel libXi-devel alsa-lib-devel

Solus

sudo eopkg install libglu-devel libx11-devel libxrandr-devel libxinerama-devel libxcursor-devel libxi-devel alsa-lib-devel

Arch

sudo pacman -S mesa libxrandr libxcursor libxinerama libxi

OpenAL is required for Ebiten's audio package. Note that the pkg's openal package is pretty old and doesn't work. Install openal-soft instead.

OpenAL が Ebiten の audio パッケージのために必要です。 pkg の openal パッケージは古くて動きません。 openal-soft を代わりにインストールしてください。

pkg install openal-soft

Ebiten

Ebiten can be used as a usual Go library. Go command automatically installs Ebiten when your program uses Ebiten.

Ebiten は通常の Go ライブラリとして使用できます。プログラムが Ebiten を使用していれば、 Go コマンドが自動的に Ebiten をインストールします。

First, create your local module. Use URL for your module name like github.com/yourname/yourgame. Actually, any module name like example.com/m is fine as long as you don't plan to share this publicly. You can change the module name anytime later.

最初に、ローカルモジュールを作ります。 github.com/yourname/yourgame のような URL をモジュール名に使用します。実際のところ、自分のプログラムを公開するつもりがないのであれば、 example.com/m などどんなモジュール名でも問題ありません。モジュール名は後でいつでも変えられます。

# Create a directory for your game.
mkdir yourgame
cd yourgame

# Initialize go.mod by `go mod`.
go mod init github.com/yourname/yourgame

Then, run the command to execute an Ebiten example. go run compiles Go files and runs it immediately after the compilation. As the first compilation might take a little long time, please wait for a while. Note that you can see what is happening on the compilation process with -x option if you want.

次に、 Ebiten のサンプルを実行します。 go run は Go ファイルをコンパイルし、即座に実行します。最初のコンパイルは少々時間がかかるかもしれないため、しばらくお待ち下さい。必要ならば -x をつけることで、コンパイル処理中に何が行われているのかを見ることができます。

Note that -tags=example is needed to execute the examples as the Ebiten example packages require the build tag.

-tags=example は Ebiten のサンプルを実行するために必要です。 Ebitne サンプルのパッケージがビルドタグを必要とするためです。

go run -tags=example github.com/hajimehoshi/ebiten/examples/rotate

If you see the window with a rotating Gophers picture, congratulations! You have succeeded to install Ebiten.

回転する Gopher の絵がウィンドウ上に表示されたならば、おめでとうございます! Ebiten のインストールに成功しました。

Rotate example