起動パラメーター
ノート: このページのコンテンツは、Unity Cloud Dashboard で使用可能な Multiplay Hosting に関連しています。Clanforge を使用している場合は、Clanforge のドキュメント を参照してください。
起動パラメーターは、起動時にゲームサーバーに渡される変数です。これらの変数は、他の構成変数より前にロードされ、構成変数 および server.json ファイル から分離されます。起動パラメーターは、サーバーが開始直後にアクセスする必要のある情報のロードに最適です。
以下のシナリオでは、構成変数の代わりに起動パラメーターを使用できます。
- ポート番号を初期化します。
- ログディレクトリを設定します。
ただし、ほとんどの場合に起動パラメーターの代わりに 構成変数 を使用する方が理にかなっています。
各起動パラメーター変数を各側 2 つのドル記号 ($$) で囲む必要があります。例えば、port という名前の起動パラメーターは $$port$$ に変換されます。以下のコードスニペットには、起動パラメーターの例があります。
-port $$port$$ -queryport $$query_port$$ -log $$log_dir$$サーバー変数
ビルド構成変数と同様に、起動パラメーター内で以下のサーバー固有変数を使用できます。以下の表に、サーバー変数の例を示します。それぞれに型、説明、値の例があります。
| 変数 | 型 | 説明 | 値の例 |
|---|---|---|---|
$$commandline$$ | string | 起動時にゲームサーバーまたはアプリケーションに渡される起動パラメーターの文字列。 | -config path/to/server.json |
$$config_dir$$ | string | Unity 設定 server.json を格納するディレクトリ。 | /mnt/unity/ |
$$fleetid$$ | string | サーバーがメンバーになっているフリートの ID。 | 5050693b-0bea-4752-858b-52c074d485fa |
$$game_exe$$ | string | 実行可能ビルドの名前。 | server-linux |
$$log_dir$$ | string | サーバーがログファイルを送信する先のディレクトリ。 | /mnt/unity/logs/ |
$$file_dir$$ | string | サーバーがゲームファイルを送信する先のディレクトリ。ログファイルもここに書き込むことができます。 | /mnt/unity/files/ |
$$machineid$$ | integer | サーバーが実行されているマシンの ID。 | 123456 |
$$port$$ | integer | サーバーがトラフィックに対してバインドする必要のあるネットワークポート。 | 1234 |
$$query_port$$ | integer | サーバーがクエリプロトコルトラフィックに対してバインドする必要のあるネットワークポート。 | 5678 |
$$query_type$$ | string | サーバーが実行しているビルドによってサポートされる クエリプロトコル。 | sqp |
$$serverid$$ | integer | サーバーの ID。 | 123456 |
$$regionid$$ | string | サーバーがメンバーになっている地域の ID。 | 3d9e29e8-3bb3-4cab-9d11-b79c90d0934d |
$$regionname$$ | string | サーバーがメンバーになっている地域の名前。 | 北米 |
$$ip$$ | string | サーバーの IP (バージョン 4) アドレス。 | 1.2.3.4 |
$$ipv6$$ | string | サーバーの IP (バージョン 6) アドレス。 | 2001:db8:3333:4444:5555:6666:7777:8888 |
$$timestamp$$ | string | サーバー開始時の UTC タイムスタンプ。 | 1661430055 |
デフォルトの起動パラメーター
以下のセクションでは、Unity で作成されたゲームと Unreal で作成されたゲームのデフォルトの起動パラメーターを示します。
ノート: ビルド構成変数は、二重のドル記号 ($$) で囲まれます。
Unity
Unity で作成されるデフォルトの起動パラメーターには、-nographics、-batchmode、-logFile があります。
ヒント: 使用できるさまざまなフラグの詳細については、Unity エディターのコマンドライン引数 を参照してください。
-nographics -batchmode -port $$port$$ -logFile $$log_dir$$/Engine.log| 起動パラメーター | 説明 |
|---|---|
-nographics | グラフィックスなしのゲーム実行ファイルを実行します。 |
-batchmode | Unity を バッチモード で実行します。バッチモードでは、Unity は人間によるインタラクションの必要なしにコマンドライン引数を実行します。 |
-logFile | サーバーがログファイルを保存する場所を指定します。サーバー ID に関連したディレクトリを受け入れ、ビルド構成変数 を格納できます。 |
ゲームによっては、起動パラメーターにクエリポート (queryPort) とクエリプロトコル (queryType) が含まれる場合もあります。
-nographics -batchmode -logFile $$log_dir$$/Engine.log -queryPort $$query_port$$ -queryType $$query_type$$Unreal
Unreal で作成されるデフォルトの起動パラメーターには -log と -port があります。
ヒント: 使用できるさまざまなフラグの詳細については、Unreal Engine command のコマンドライン引数 を参照してください。
-log=$serverid.log -port=$$port$$| 起動パラメーター | 説明 |
|---|---|
-log | サーバーが ログファイル を保存する場所を指定します。 |
-port | クライアントがゲームサーバーに接続するために使用できるポートを指定します。 |
ゲームと使用している SDK によっては、起動パラメーターにクエリポート (queryPort) とクエリプロトコル (queryType) が含まれる場合があります。
-log=$serverid.log -port=$$port$$ -queryPort $$query_port$$ -queryType $$query_type$$