コマンドラインチュートリアル

一部の開発者は、コマンドラインを広範囲に使用することを好みます。Godotは使いやすく設計されているので、ここでは完全にコマンドラインから作業するための手順を説明します。エンジンが外部ライブラリーにほとんど依存しないことを考えると、初期化時間は非常に速く、このワークフローに適しています。

コマンドライン リファレンス

一般的なオプション

コマンド 説明
-h, --help, /? コマンド ライン オプションの一覧を表示します。
--version バージョン文字列を表示します。
-v, --verbose 詳細な標準出力モードを使用します。
--quiet 静かなモード、標準出力メッセージを出力しません。エラーは引き続き表示されます。

実行オプション

コマンド 説明
-e, --editor シーンを実行する代わりにエディタを起動します(tools を有効にする必要があります)。
-p, --project-manager プロジェクトが自動検出された場合でも、プロジェクトマネージャを起動します(tools を有効にする必要があります)。
-q, --quit 最初のイテレーションの後に終了します。
-l <locale>, --language <locale> 特定のロケールを使用します(<locale>は2文字のコードです)。詳細については、 Locales を参照してください。
--path <directory> プロジェクトへのパス (<directory>には 'project.godot' ファイルが含まれている必要があります)。
-u, --upwards 'project.godot' ファイルのフォルダを上方向にスキャンします。
--main-pack <file> 読み込むパック (.pck) ファイルへのパス。
--render-thread <mode> レンダー スレッド モード ('unsafe', 'safe', 'separate')。詳細については、 Thread Model を参照してください。
--remote-fs <address> リモート ファイルシステム (<host/IP>[:<port>] アドレス)。
--audio-driver <driver> オーディオ ドライバー。最初に --help を使用して、使用可能なドライバーの一覧を表示します。
--video-driver <driver> ビデオドライバー。最初に --help を使用して、使用可能なドライバーの一覧を表示します。

表示オプション

コマンド 説明
-f, --fullscreen 全画面表示モードを指定します。
-m, --maximized ウィンドウの最大化を指定します。
-w, --windowed ウィンドウ モードを指定します。
-t, --always-on-top 常時最前面 ウィンドウを指定します。
--resolution <W>x<H> ウィンドウの解像度を指定します。
--position <X>,<Y> ウィンドウの位置を指定します。
--low-dpi 低DPIモードを強制します (macOS および Windows のみ)。
--no-window ウィンドウの作成を無効にします (Windows のみ)。 -script と併用すると便利です。

デバッグオプション

注釈

デバッグ オプションは、エディタおよびデバッグ エクスポート テンプレートでのみ使用できます (これらには debug または release_debug ビルド ターゲットが必要です、詳細については、 ターゲット を参照してください)。

コマンド 説明
-d, --debug デバッグ (ローカル stdout デバッガー)。
-b, --breakpoints ブレークポイントとしてソースの行番号をカンマで区切って列挙します。スペースは使えません(代わりに%%20を使用できます)。
--profiling スクリプト デバッガーでプロファイリングを有効にします。
--remote-debug <address> リモート・デバッグ (addressは<ホスト/IP>:<ポート>).
--debug-collisions シーンを実行する際にコリジョン形状を表示する。
--debug-navigation シーンを実行する際にナビゲーション・ポリゴンを表示する。
--frame-delay <ms> 高CPU負荷の再現 (毎フレームごとに <ms> ミリ秒遅らせる)。
--time-scale <scale> タイムスケールの強制 (値が大きいほど早く、1.0が標準)。
--disable-render-loop レンダリングのループの無効化。スクリプトにて明示的に呼び出した時にのみレンダーする。
--disable-crash-handler プラットフォーム・コードが対応している場合もクラッシュ・ハンドラを無効にする。
--fixed-fps <fps> フレーム毎秒の固定。この設定によりリアルタイム同期は無効化。
--print-fps stdoutにフレーム毎秒を出力。

スタンドアロンツール

コマンド 説明
-s <script>--script <script> スクリプトの実行。
--check-only エラー分析のみ行って終了(--scriptと同時に使用)。
--export <target> 指定されたエクスポート・ターゲットに向けてプロジェクトをエクスポートする。パスが .pck あるいは .zip で終わっている場合、メインのパックのみエクスポートする (toolsを有効にする必要あり)。
--export-debug <target> --exportと同じだが、デバッグ・テンプレートを使用する。(toolsを有効にする必要あり)。
--doctool <path> 指定した <path> にエンジンのAPIリファレンスをXML形式で出力する。すでにファイルが存在する場合は、それに結合する。(toolsを有効にする必要あり)。
--no-docbase 基本タイプのダンプをしない (--doctoolと共に使用。toolsを有効にする必要あり)。
--build-solutions スクリプトのソリューションをビルドする (例えばC#プロジェクトのために。toolsを有効にする必要あり)。
--gdnative-generate-json-api GDNativeバインディング用のGodot APIのJSONダンプを生成します (tools を有効にする必要があります)。
--test <test> 単体テストを実行します。最初に --help を使用して、テストの一覧を表示します。(tools を有効にする必要があります)。

パス

godot と入力すればどこからでも簡単に実行できるように、godotバイナリをPATH環境変数に含めることをお勧めします。Linuxでは、 /usr/local/bin にgodotバイナリを配置し、それが godot と呼ばれていることを確認することで、これを行うことができます。

プロジェクトパスの設定

Godotバイナリの場所と現在の作業ディレクトリによっては、次のコマンドを正しく機能させるためにプロジェクトへのパスを設定する必要があります。

これは、プロジェクトの project.godot ファイルへのパスを最初の引数として指定することで実現できます:

[email protected]:~$ godot path_to_your_project/project.godot [other] [commands] [and] [args]

または --path 引数を使用して:

[email protected]:~$ godot --path path_to_your_project [other] [commands] [and] [args]

たとえば、ゲームをエクスポートするための完全なコマンド(以下に説明する)は次のようになります:

[email protected]:~$ godot --path path_to_your_project --export my_export_preset_name game.exe

プロジェクトの作成

コマンドラインからプロジェクトを作成するには、シェルを目的の場所に移動してproject.godotファイルを作成します。

[email protected]:~$ mkdir newgame
[email protected]:~$ cd newgame
[email protected]:~/newgame$ touch project.godot

これで、Godotでプロジェクトを開くことができます。

エディタの実行

エディタを実行するには、Godotに -e フラグを付けて実行します。これは、プロジェクトディレクトリまたはサブディレクトリ内から実行する必要があります。それ以外の場合、コマンドは無視され、プロジェクトマネージャが表示されます。

[email protected]:~/newgame$ godot -e

シーンが作成および保存されている場合は、そのシーンを引数として同じコードを実行することで、後で編集できます。

[email protected]:~/newgame$ godot -e scene.tscn

シーンの削除

Godotはあなたのファイルシステムと友達であり、追加のメタデータファイルを作成することはありません。シーンファイルを削除するには、 rm を使用します。 そのシーンを参照するものが何もないことを確認してください。

[email protected]:~/newgame$ rm scene.tscn

ゲームの実行

ゲームを実行するには、プロジェクトディレクトリまたはサブディレクトリ内でGodotを実行します。

[email protected]:~/newgame$ godot

特定のシーンをテストする必要がある場合は、そのシーンをコマンドラインに渡します。

[email protected]:~/newgame$ godot scene.tscn

デバッグ

コマンドラインでエラーを検出するのは非常に困難な作業です。 -d を追加することでコマンドラインデバッガが利用できます。これは、ゲームまたは単一のシーンを実行するために機能します。

[email protected]:~/newgame$ godot -d
[email protected]:~/newgame$ godot -d scene.tscn

エクスポート

コマンドラインからプロジェクトをエクスポートすることもサポートされています。これは継続的インテグレーション設定に特に役立ちます。これには、ヘッドレスのGodotバージョン(サーバービルド、ビデオなし)が理想的です。

[email protected]:~/newgame$ godot --export "Linux/X11" /var/builds/project
[email protected]:~/newgame$ godot --export Android /var/builds/project.apk

--export スイッチによって認識されるプラットフォーム名は、エディタのエクスポートウィザードに表示されるものと同じです。サポートされているプラットフォームの一覧をコマンドラインから取得するには、認識されていないプラットフォームにエクスポートすると設定がサポートしているプラットフォームの一覧が表示されます。

ゲームのデバッグバージョンをエクスポートするには、 --export の代わりに --export-debug スイッチを使用します。パラメータと使用方法は同じです。

スクリプトの実行

コマンドラインから単純な.gdスクリプトを実行することは可能です。この機能は大規模プロジェクトでアセットの一括変換やカスタムのインポート/エクスポートに特に便利です。

スクリプトはSceneTreeまたはMainLoopから継承する必要があります。

簡単な動作例を次に示します:

#sayhello.gd
extends SceneTree

func _init():
    print("Hello!")
    quit()

実行方法:

[email protected]:~/newgame$ godot -s sayhello.gd
Hello!

パスにproject.godotが存在しない場合は、現在のパスが現在の作業ディレクトリであると見なされます( -path が指定されている場合を除く)。