IDEの構成

すでにGodotのクローンを作成 し、コンパイルしたとします。

任意のテキストエディタを使用してコマンドラインで scons を呼び出すことで簡単にGodotを開発できますが、IDE(統合開発環境)で作業する場合の、いくつかの一般的なもののセットアップ手順を以下に示します:

  • Qt Creator (すべてのデスクトッププラットフォーム)
  • Kdevelop (すべてのデスクトッププラットフォーム)
  • Xcode (macOS)
  • Visual Studio (Windows)
  • Visual Studio Code (すべてのデスクトッププラットフォーム)
  • Android Studio (すべてのデスクトッププラットフォーム)
  • CLion (すべてのデスクトッププラットフォーム)

他のIDEを使用することは可能ですが、それらのセットアップはまだ文書化されていません。

Qt Creator

プロジェクトのインポート

  • 新しいプロジェクトプロジェクトのインポート既存プロジェクトのインポートを を選択します。
../../_images/qtcreator-new-project.png
  • Godotルートディレクトリへのパスを設定し、プロジェクト名を入力します。
../../_images/qtcreator-set-project-path.png
  • ここでは、プロジェクトに表示するフォルダとファイルを選択できます。C/C++ファイルは自動的に追加されます。利用可能な拡張子: ビルドシステムファイルの *.py、Android 開発用 *.java、macOS用 *.mm。[次へ] をクリックします。
../../_images/qtcreator-apply-import-filter.png
  • 完了 をクリックします。
  • . を含む行をproject_name.includesに追加して、作業コードの完了を取得します。
../../_images/qtcreator-project-name-includes.png

ビルドと実行

ビルド構成:

  • プロジェクトをクリックし、ビルドタブを開きます。
  • 定義済みの make ビルド ステップを削除します。
../../_images/qtcreator-projects-build.png
  • ビルドステップを追加 -> カスタムプロセスステップをクリックします。
../../_images/qtcreator-add-custom-process-step.png
  • Command フィールドに scons と入力します。Could not start process "scons" で失敗した場合、sconsPATH 環境変数にないため、SConsバイナリへのフルパスを使用しなければならない可能性があります。
  • 引数フィールドにコンパイルオプションを入力します。(例: p=x11 target=debug -j 4 )
../../_images/qtcreator-set-scons-command.png

構成の実行:

  • 実行タブを開きます。
  • Executable をコンパイル済みのGodotバイナリにポイントします(例: %{buildDir}/bin/godot.x11.opt.tools.64)
  • 特定のゲームまたはプロジェクトを実行する場合は、作業ディレクトリをゲームディレクトリに指定します。
  • エディタを実行する場合は、コマンドライン引数フィールドに -e を追加します。
../../_images/qtcreator-run-command.png

最新のコミットをプルした後のソースの更新

開発者は、通常、上流のgitリポジトリまたは特定のフォークなどから最新のコミットを頻繁にプルする必要があります。ただし、開発を続けると、ソースファイル(およびフォルダ)が追加または削除されるため、少し問題が生じます。 これらの変更はQt Creatorのプロジェクトファイルにも反映される必要があるため、それをちゃんと反映した上で引き続きコーディングを行ってください。チェックする簡単な方法は、"Projects View"のルートフォルダを右クリックし、"Edit files..."をクリックすることです。

../../_images/qtcreator-edit-files-menu.png

これで、 "Importing the project" セクションの3番目のステップの機能と同様の新しいダイアログが表示されます。ここで、特定のファイルやフォルダを追加または削除するかどうかを確認できます。マウスでクリックするか、単に "Apply Filter" ボタンをクリックするだけで選択できます。 "OK" をクリックするだけで、作業を続行できます。

../../_images/qtcreator-edit-files-dialog.png

コードスタイル設定

開発者はプロジェクトの コードスタイル に従う必要があり、IDEはそれを支援する必要があります。デフォルトでは、Qt Creatorはインデントにスペースを使用しますが、これはGodotプロジェクトでは正しくありません。この動作を変更するには、オプションC++ の「コードスタイル」を変更します。

../../_images/qtcreator-options-cpp.png

[編集]をクリックして現在の設定を変更し、[ビルトイン コードスタイルをコピー]ボタンをクリックして新しいコードスタイルを設定します。名前を設定し(例: Godot)、タブポリシーを タブのみ に変更します。

../../_images/qtcreator-edit-codestyle.png

KDevelop

KDevelop は、すべてのデスクトッププラットフォーム向けの無料のオープンソースIDEです。

ビデオチュートリアルは こちら です。または、このテキストバージョンのチュートリアルに従ってください。

KDevelopを開き、"open project" を選択して開始します。

../../_images/kdevelop_newproject.png

Godotのクローンを作成したディレクトリを選択します。

次の画面で、Project manager の "Custom Build System" を選択します。

../../_images/kdevelop_custombuild.png

プロジェクトがインポートされたので、プロジェクトの設定を開きます。

../../_images/kdevelop_openconfig.png

次を includes/imports に追加します:

.  // a dot to indicate the root of the Godot project
core/
core/os/
core/math/
drivers/
platform/x11/  // make that platform/osx/ if you're using macOS
../../_images/kdevelop_addincludes.png

変更(Apply)を適用します。

"Custom Build System" タブに切り替えます。ビルド構成(Build configuration)を追加し、ビルドディレクトリ(Build Directory)を空白のままにします。ビルドツール(Build Tools)を有効(Enable)にし、実行可能ファイル(Executable)として `` scons`` を追加してから、引数(Arguments)として platform = x11 target = debug (macOSを使用している場合は `` platform = osx``)を追加します。

../../_images/kdevelop_buildconfig.png

次に、バイナリを見つける場所をKDevelopに指示する必要があります。"Run" メニューから[起動設定]を選択します。

../../_images/kdevelop_configlaunches.png

ランチャーが存在しない場合は、[追加] をクリックします。次に、実行可能(Executable)セクションに実行可能ファイルへのパスを追加します。実行可能ファイルは bin/ サブディレクトリに配置し、godot.x11.tools.64 のような名前を付ける必要があります(名前はプラットフォームやビルドオプションによって異なる場合があります) 。

../../_images/kdevelop_configlaunches2.png

以上です!これで準備完了です (^^)

Xcode

プロジェクトの設定

  • 任意の場所にXcode外部ビルドプロジェクトを作成する
../../_images/xcode_1_create_external_build_project.png
  • ビルドツールをsconsへのパスに設定します

ビルドターゲットのXcode情報タブを変更します:

  • 引数を次のようなものに設定します: platform=osx tools=はい bits=64 target=debug
  • Directoryを Godot のソース フォルダへのパスに設定します。プロジェクトが既に存在する場合は、空白のままにします。
  • 環境内のビルド設定を渡すのチェックを外すことができます
../../_images/xcode_2_configure_scons.png

コマンドラインターゲットの追加:

  • [Xcodeファイル]> [新規]> [ターゲット...]に移動し、新しいXcodeコマンドラインターゲットを追加します
../../_images/xcode_3_add_new_target.png ../../_images/xcode_4_select_command_line_target.png
  • このターゲットでコンパイルしないように名前を付けます
  • 例: GodotXcodeIndex
  • 新しく作成したターゲットのビルド設定タブに移動し、ヘッダー検索パスを検索します
  • ヘッダー検索パスをGodotのソースフォルダへの絶対パスに設定する
  • パスの末端に 「**」を追加して再帰的にする
  • 例: /Users/me/repos/godot-source/\**

プロジェクトにGodotソースを追加する:

  • Godotソースをプロジェクトファイルブラウザにドラッグアンドドロップします。
  • チェックを外す: 外部ビルド システムの作成
../../_images/xcode_5_after_add_godot_source_to_project.png
  • 次へをクリックします
  • グループの作成を選択
../../_images/xcode_6_after_add_godot_source_to_project_2.png
  • ターゲットに追加セクションでコマンドラインターゲットのみをオフにします
  • 終了をクリックします。次に、Xcodeがファイルのインデックスを作成します。
  • コーヒーを1杯取って...もしかしたら、何か食べるものも作るかもしれません
  • 定義、自動補完、および完全な構文の強調表示が完了したら、その定義にジャンプする必要があります。

スキームのセットアップ

外部ビルドターゲットのビルドスキームの編集:

  • 外部ビルドターゲットのオープンスキームエディタ
  • ビルドメニューを展開する
  • アクションの投稿へ飛ぶ
  • 新しいスクリプト実行アクションを追加し、 Provide build settings from でプロジェクトを選択すると、 ${PROJECT_DIR} 変数を使用することができます。
../../_images/xcode_7_setup_build_post_action.png
  • Xcodeが認識する名前をバイナリに与えるスクリプトを記述する
  • 例: ln -f ${PROJECT_DIR}/godot/bin/godot.osx.tools.64 ${PROJECT_DIR}/godot/bin/godot
  • 外部ビルドターゲットの構築

外部ビルドターゲットの実行スキームの編集:

  • スキームエディタを再度開きます
  • 実行をクリック
../../_images/xcode_8_setup_run_scheme.png
  • Executableを、ビルド後のアクションスクリプトでリンクしたファイルに設定します
  • まだ実行されていない場合は、デバッグ実行可能ファイルをチェックします
  • 引数タブに移動し、プロジェクトに -e と -path を追加して、プロジェクト選択画面ではなくエディタをデバッグできます

それをテストします:

  • プラットフォーム /osx/godot_main_osx.mm でブレークポイントを設定する
  • そのポイントでブレークするはずです!

Visual Studio Code

  • C/C++拡張機能がインストールされていることを確認してください。手順は docs にあります。
  • Open cloned godot folder in VS Code with File > Open Folder...

In order to build the project, you need two configuration files: launch.json and tasks.json. To create them:

  • Open Debug view by pressing Ctrl + Shift + D and select cogwheel with an orange dot:
../../_images/vscode_1_create_launch.json.png
  • C++ (GDB/LLDB) を選択します(macOSまたはWindowsでは異なる名前が付けられる場合があります)
  • 一致するように launch.json を更新します:
../../_images/vscode_2_launch.json.png

("program"値の godot.x11.tools.64 の名前は、macOSまたはWindowsでは異なる場合があることに注意してください)

  • Create tasks.json by starting the Debug process with F5. VS Code will show a dialog with a Configure Task button. Tap it and select Create tasks.json file from template, then select Others
  • 一致するように tasks.json を更新します:
../../_images/vscode_3_tasks.json.png

(platform = x11 はmacOXとWindowsでは異なります)

  • デバッグプロセスを再度開始して、すべてが機能することをテストできます。
  • ビルドフェーズが失敗した場合は、コンソールでヒントを確認してください。 Linuxでは、いくつかの依存関係が欠落している可能性が最も高いです。要確認 X11用のコンパイル (Linux、* BSD)

Android Studio

Android Studio is a JetBrains IDE for Android development. It has a feature-rich editor which supports Java and C/C++, so it can be used for development of the Godot core engine, and Android platform codebases.

プロジェクトの設定

  • Android Studio Welcome to Android Studio ウィンドウから、Open an existing Android Studio project を選択します
../../_images/android_studio_setup_project_1.png
  • <godot root directory>/platform/android/java に移動し、settings.gradle gradleファイルを選択します。
  • Android Studioはプロジェクトをインポートしてインデックスを作成します。
  • プロジェクトをビルドするには、コンパイル手順 に従ってください。

CLion

CLion はC++用の商用IDEです。プロジェクトファイルとして CMakeLists.txt ファイルが必要です。これは、CMakeではなくSConsビルドシステムを使用するGodotにとって問題です。ただし、CLionでも使用できる Android StudioCMakeLists.txt 設定があります。

  • FileOpen を選択します。
  • Godot Gitクローンに移動し、platform/android/java/lib フォルダを選択します(CMakeLists.txt ファイルはそこにあります)。CMakeLists.txtファイル ではなく、フォルダを選択します。次に、OK をクリックします。
../../_images/clion_1_open.png
  • このポップアップウィンドウが表示されたら、This window を選択してプロジェクトを開きます。
../../_images/clion_2_this_window.png
  • ToolsCMakeChange Project Root を選択し、ルートGodotフォルダを選択します。
../../_images/clion_3_change_project_root.png
  • これで、すべてのプロジェクトファイルを表示できるはずです。プロジェクトのインデックス作成が完了すると、オートコンプリートが機能するはずです。