Axmol Engine のインストールとビルド(Windows 上)

概要

Axmol Engine は,C++ で書かれた2次元・3次元のゲームエンジンである。Cocos2d-x v4.0 を基に2019年11月に開始されたフォーク(派生プロジェクト)であり,現在も活発に更新が続いている。Cocos2d-x は2019年以降更新が止まっており,公式には新規開発者に Cocos Creator(ビジュアル編集機能を持つ別系統のエンジン)への移行が案内されているため,Cocos2d-x の流れで C++ による開発を続けたい場合は,Axmol Engine が実用的な選択肢となる。このページでは,Axmol Engine を Windows 上でビルドし,プロジェクトを作成する手順を説明する。Axmol Engine のビルドには PowerShell,Visual Studio 2022 以降,Python 3.12 を用いる。

目次

関連する外部ページ

Axmol Engine の公式リポジトリ: https://github.com/axmolengine/axmol
Axmol Engine の開発セットアップ手順(公式): https://github.com/axmolengine/axmol/blob/dev/docs/DevSetup.md

サイト内の関連情報

謝辞:Axmol Engine の作者,および Cocos2d-x の作者に感謝します。

前準備

Python 3.12 のインストール

Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

以下のいずれかの方法でPython 3.12をインストールする。Pythonがインストール済みの場合、この手順は不要である。

方法 1:winget によるインストール

インストールコマンドの実行方法

管理者権限コマンドプロンプトを起動する(手順:Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」)。そして、コマンド全体をコマンドプロンプトにコピー&ペーストする。

--scope machine を指定することで、システム全体(全ユーザー向け)にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動するとPATHが反映される。

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

方法 2:インストーラーによるインストール

  1. Python公式サイト(https://www.python.org/downloads/)にアクセスし、「Download Python 3.x.x」ボタンからWindows用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」にチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号(例:Python 3.12.x)が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

Axmol Engine のビルドスクリプトは Python 2 系・3 系のいずれでも動作する。このページでは Python 3.12 を用いる。Python 公式サイトから Windows 用のインストーラをダウンロードし,インストールする。インストール時に「Add python.exe to PATH」を有効にすること。

PowerShell 7 のインストール

Axmol Engine のセットアップスクリプトは PowerShell で実行する。Windows 10 以降には PowerShell 5.x が標準で入っており,これでも動作するが,PowerShell 7 の使用が推奨されている(特に Android 向けビルドで,コマンドラインツールの zip 展開に PowerShell 5 では失敗する場合があるため)。PowerShell 7 の配布ページから Windows 用のインストーラをダウンロードし,インストールする。

Visual Studio 2022 以降のインストール(Windows 上)

Axmol Engine の Windows 上でのビルドには,Visual Studio 2022(バージョン17.9以上)または Visual Studio 2026 が必要である。MSVC のツールセットは v14.39 以上が必要である。Visual Studio Installer で「C++ によるデスクトップ開発」ワークロードを選択してインストールする。UWP(Xbox 向けを含む)開発を行う場合は,「WinUI アプリケーション開発ツール」ワークロードと,オプション コンポーネントの「C++ Universal Windows Platform tools」も追加する。

Visual Studio の完全な IDE を導入せず,Build Tools for Visual Studio だけを使ってビルドすることもできる。ただし,開発のしやすさの点から Visual Studio の IDE を導入することが推奨されている。

Android 向けにビルドする場合

Axmol Engine では,Android Studio や Android NDK を個別にインストールする必要はない。後述のセットアップスクリプトに -p android を付けて実行すると,必要な NDK(2026年時点の Axmol v2 系では r23d 以上)が自動的にダウンロードされ,環境変数も自動的に設定される。Android Studio でプロジェクトを開いて開発したい場合は,別途 Android Studio をインストールしておく。

ダウンロードと展開,ビルド

  1. Axmol Engine の GitHub リポジトリのリリースページを開く

    https://github.com/axmolengine/axmol/releases

    ZIP ファイルからインストールすると,Windows の制限によって PowerShell スクリプトの実行がブロックされる場合がある。この問題を避けるため,Git を使って次のようにリポジトリを複製(clone)する方法が推奨されている。
    git clone https://github.com/axmolengine/axmol.git
    cd axmol
  2. PowerShell を開き,スクリプトの実行を許可するポリシーを設定する(複製したリポジトリを使う場合)。
    Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned -Force
  3. 複製したディレクトリで,セットアップスクリプトを実行する。依存関係のインストールと,環境変数の設定が行われる。
    ./setup.ps1

    Android 向けのビルドも行いたい場合は,次のように -p android を付けて実行する。この場合,Android SDK・NDK が自動的にダウンロードされる。

    ./setup.ps1 -p android
  4. スクリプトの実行が終わったら,ターミナルを再起動する。環境変数の設定を反映させるためである。
  5. 新しく PowerShell を開き,axmol コマンドが使えることを確認する。
    axmol --version

    エラーメッセージが出ていないことを確認する。

Axmol Engine でプロジェクトの作成

ここでの設定は,プロジェクト名を hoge00,パッケージ名を hoge.hoge.com とする。

  1. PowerShell を開く。
  2. プロジェクトを作成したいディレクトリに移動し,次のコマンドでプロジェクトを新規作成する。-l には cpp(C++)または lua(Lua)を指定できる。ここでは C++ を選ぶ。
    axmol new -p hoge.hoge.com -d .\ -l cpp hoge00
    cd hoge00
  3. 結果を確認する。エラーメッセージが出ていないこと,プロジェクトのディレクトリと必要なファイルが作成されていることを確認する。
  4. Windows(win32)向けに,Visual Studio のソリューションファイルを生成する。-c オプションを付けると,IDE 用のプロジェクトファイル(Visual Studio のソリューション)が生成される。
    axmol -p win32 -c
  5. 生成された build ディレクトリの下にあるソリューションファイルを開く。Visual Studio 2022 を使う場合は拡張子が .sln,Visual Studio 2026 を使う場合は .slnx のファイルである。
  6. Visual Studio が起動するので,確認する。
  7. 「ソリューション」を右クリックし,「ビルド」→「ソリューションのビルド」と操作してビルドする。
  8. ビルドの終了を確認する。エラーメッセージが出ていないこと。
  9. 「デバッグ」→「デバッグなしで開始」と操作して,実行してみる。
  10. Hello World の画面が開くことを確認する。
  11. ソースコードやリソース(画像・音声など)を追加したときは,Visual Studio のプロジェクトファイルを作り直す必要がある。その場合は,ソリューションを閉じてから,手順4のコマンドをもう一度実行する。