Android向けのカスタムビルド

Godotには、カスタムビルド Androidテンプレートを使用するオプションが用意されています。Godotに同梱されている既製のテンプレートを使用する代わりに、実際のAndroid Javaプロジェクトがプロジェクトフォルダにインストールされます。Godotはそれをビルドし、プロジェクトをエクスポートするたびにエクスポートテンプレートとして使用します。

これを行う理由はいくつかあります:

  • ビルドする前にプロジェクトを変更します。
  • プロジェクトでビルドする外部SDKを追加します。

カスタムビルドの設定は、多かれ少なかれ簡単なプロセスですが、Android SDKの動作に慣れるまでに時間がかかる場合があります。

このプロセスを行うための手順は、可能な限り詳細に提供されます。

カスタムビルド環境をセットアップする

[プロジェクト] メニューに移動し、カスタム ビルド テンプレートをインストールします。

../../../_images/custom_build_install_template.png

エクスポート テンプレートがダウンロードされていることを確認します。そうでない場合は、このメニューを使用してダウンロードできます。

A Gradle-based Android project will be created under res://android/build. Editing these files is not needed unless you want to create your own add-ons, or you really need to modify the project.

Android SDKのインストール(コマンドラインバージョン)

コマンド ラインを使用してAndroid SDKをインストールする手順を次に示します。このアプローチの利点は、シンプルさと小さなダウンロード/インストールサイズです。しかし、それはかなり挑戦的な作業です。Android Studioのアプローチは簡単ですが、Android Studioのダウンロードとインストールが必要です(1GBを超えるストレージが必要な場合があります)。

JDKのインストール

The Android SDK doesn't come with Java, so it needs to be installed manually. You need to install a Java SDK (not just the runtime or JRE). OpenJDK 8 is required, newer versions won't work.

On Windows, make sure that you enable "Set JAVA_HOME variable" in the Custom Setup view of the installer. You have to restart Godot after this, otherwise Godot can't find the JAVA_HOME variable.

コマンドラインツールをダウンロード

Android Studioダウンロードページ に移動します。完全なIDEは必要ないので、ディスク容量を節約するために、それはダウンロードしないでください。

注釈

Android Studioが必要な場合は、Android Studioを使用して同じことを行うための手順をさらに読んでください。

Look on that page for the Command line tools only section. Currently, they are listed under Download Options. Scroll down a bit until you see them and download the ZIP file for your platform.

これは少しわかりにくいかもしれませんが、次の指示に注意深く従ってください。

任意の場所に android-sdk という名前の新しいフォルダを作成します(空のディレクトリでなければなりません)。 Windowsでは、通常、次のパスで十分です。

C:\users\<yourusername>\android-sdk

Create an empty folder named cmdline-tools inside of the android-sdk folder. Then unzip the Android SDK ZIP file into the android-sdk/cmdline-tools folder.

注釈

If you're on Windows, you must not extract the ZIP archive with the default Windows extractor (e.g. Windows Explorer). You have to use another tool like 7zip, WinRAR or the Powershell Expand-Archive command. If you extract the archive with the default Windows extractor, the files are not extracted correctly and you will run into errors later on!

The cmdline-tools folder should now contain the unzipped folder called tools. Finally, rename the tools folder to latest.

Your final directory structure should look like this :

android-sdk/
android-sdk/cmdline-tools/
android-sdk/cmdline-tools/latest
android-sdk/cmdline-tools/latest/allTheOtherFiles

We need to setup the directory structure this way for the sdkmanager (inside the bin folder) to work.

ライセンスへの同意

Android SDKツールを使用できるようにするには、そのライセンスに同意する必要があります。

これを行うには、コマンドラインから特別な引数を指定して sdkmanager を実行する必要があります。SDKフォルダ内の tools/bin ディレクトリに移動します(LinuxおよびmacOSユーザーはコマンドラインナビゲーションのしくみを理解することが求められているため、Windowsユーザー向けの手順を参照してください):

../../../_images/custom_build_bin_folder.png

次に、コマンド ラインウィンドウを開きます:

../../../_images/custom_build_open_shell.png

そこで sdkmanager --licenses を実行します:

../../../_images/custom_build_sdkmanager.png

これにより、いくつかのライセンスを受け入れるように求められます。y と入力し、すべてが完了するまで Enter を押します。

その後、プラットフォームツールをインストールします(adb をインストールするために必要です):

../../../_images/custom_build_platform_tools.png

If you get an error saying Warning: Could not create settings, try ./sdkmanager --sdk_root=../../ --licenses or ./sdkmanager --sdk_root=../../ platform-tools. These must be executed inside the /tools/bin/ folder because the path for --sdk_root is relative.

キーストアの作成

プラットフォームツール をインストールしたら、最後のステップはデバッグキーストアを生成することです(これはビルドに必要です)。次のように記述して、2つのフォルダに移動します:

cd ..\..\..

(または android-sdk フォルダで新しいシェルを開きます)。

And you need to input the following line (This should work out of the box. However, if you haven't set the JAVA_HOME variable on Windows, there are further instructions below):

keytool -keyalg RSA -genkeypair -alias androiddebugkey -keypass android -keystore debug.keystore -storepass android -dname "CN=Android Debug,O=Android,C=US" -validity 9999

On Windows, if you did not install the JAVA_HOME variable, the full path to Java should be provided. You need to add & at the beginning of the line if you use PowerShell; it's not needed for the regular cmd.exe console.

わかりやすくするために、PowerShellで機能する行のキャプチャを次に示します(&keytool.exe の前に完全なJavaパスを追加する)。繰り返しますが、Javaをインストールする必要があることに注意してください。

../../../_images/custom_build_command_line.png

(画像が小さすぎる場合は、右クリックして新しいタブで開きます)

ゴドーの設定

エディタ設定に移動し、Export > Android でいくつかのフィールドを設定します。次のように表示されていることを確認します。

../../../_images/custom_build_editor_settings.png

(画像が小さすぎる場合は、右クリックして新しいタブで開きます)

ご覧のように、ほとんどのパスは、最初に作成した android-sdk フォルダ内、またはJavaインストール内にあります。Linuxおよび macOSユーザーの場合、一般的に jarsigner/usr/bin 内にあります。

これで、すべての準備が整います。

Android SDK(Android Studio)のインストール

コマンドラインツールを使用してSDKのインストールを完了している場合は、このセクションを完全にスキップしてください。 Android Studioを使用する道筋は手順が簡単ですが、より多くのディスク容量を占有します。ですが、 Android用のGodotの開発(Javaソースコードの変更)を計画している場合、またはアドオンの開発を計画している場合にも役立ちます。

Android Studioのダウンロードとインストール

Android Studioの最新バージョンをダウンロードします。インストール時に、android-sdk ディレクトリが作成される場所に注意してください。

../../../_images/custom_build_install_android_studio1.png

注釈

これは奇妙な事ですが、デフォルトで提案するパスには空白が含まれています(そして、それについて文句を言います)。なので、変更する必要があります。

いずれにしても、ユーザーフォルダ内で別のパスを選択するほうが良いでしょう。通常は次をお勧めします:

C:\Users\<yourusername>\Documents\android-sdk

Replace yourusername by your actual user name. Once it's correct, select from the list above in the same screen:

  • Android SDK
  • Android SDK Platform

それらを選択した後、インストールに進みます。その他の項目はビルド システムが自動で選択するため、手動での選択は必要ありません。

キーストアの作成

前の手順で android-sdk をインストールしたフォルダに移動し、エクスプローラーを使用してコマンドラインツールを開きます:

../../../_images/custom_build_open_shell.png

入力する実際のコマンドラインは次のとおりです。 LinuxおよびmacOSでは、そのまま使用できますが、Windowsでは、細かい追加が必要です(後ほど説明があります)。

keytool -keyalg RSA -genkeypair -alias androiddebugkey -keypass android -keystore debug.keystore -storepass android -dname "CN=Android Debug,O=Android,C=US" -validity 9999

Windowsでは、Javaへのフルパスを指定する必要があります(PowerShellを使用する場合は、行の先頭に & を追加する必要があります。通常の cmd.exe コンソールには必要ありません)。WindowsでAndroid Studioを使用すると、最低でもJavaがバンドルされるので、Javaについて心配する必要はありません。

わかりやすくするために、PowerShellで機能する行のスクリーンキャプチャを次に示します(& と、Javaへのフルパスを keytool.exe に追加します。cmd.exe を使用する場合は ``&``を削除します)。このパスにはAndroid Studioに付属しているJavaバージョンへのパスを使用します:

../../../_images/custom_build_command_line2.png

(画像が小さすぎる場合は、右クリックして新しいタブで開きます)

ゴドーの設定

エディタ設定に移動し、Export > Android でいくつかのフィールドを設定します。次のように表示されていることを確認します。

../../../_images/custom_build_editor_settings2.png

(画像が小さすぎる場合は、右クリックして新しいタブで開きます)

ご覧のように、ほとんどのパスは、最初に作成した android-sdk フォルダ内、またはJavaインストール内にあります。Linuxおよび macOSユーザーの場合、一般的に jarsigner/usr/bin 内にあります。

これで、すべての準備が整います。

カスタムビルドとエクスポートの有効化

プロジェクト>エクスポート ダイアログでAndroidプロジェクトを設定する場合、Custom Build を有効にする必要があります。

../../../_images/custom_build_enable.png

今後、プロジェクトのエクスポートまたはワンクリックデプロイを試みると、Gradle <https://gradle.org/> ビルドシステムが呼び出され、新しいテンプレートが生成されます(このウィンドウは毎回表示されます):

../../../_images/custom_build_gradle.png

作成されたテンプレートは後で自動的に使用されるため、それ以上の構成は必要ありません。