ゲームサーバー公開(ホスト)ツール - CUI版の使い方
Q. CUI版とは?

CUI版は主に、GUI版のように、画面をクリックしたり、入力したりして使うものではなく、全てコンソール(コマンドプロンプトやシェル、ターミナルなど)で操作するものになります。主に作業を自動化したい場合などに用います。


CUI版の導入方法
1. 本ツールHPより、「CUI版」の公開ツールを利用したい環境に合わせてダウンロードしてください。

Windows版はこちら

2. コマンドプロンプトを開き、CUI版をダウンロードしたディレクトリ(フォルダ)へ移動します。
移動は以下のコマンドで行えます。(エクスプローラーの機能を利用して今開いているフォルダでコマンドプロンプトを起動することも可能です。方法は何でもOKです。)

> cd /d [gsht.exeをダウンロードしたフォルダのパス]
例↓ (gsht.exeをDドライブの下にあるtoolフォルダに保存したときの場合)
> cd /d D:\tool

3. 実行します。(初回のみモジュールのダウンロードがあるため、少し時間がかかります。)
以下のコマンドで実行できます。
> gsht

次のような画面で終了すれば正常に動作しています。これ以降は、どのOSでも同じ操作です。使い方は以下をご覧ください。

Linux版はこちら

2. ターミナル・シェルを開き、CUI版をダウンロードしたディレクトリ(フォルダ)へ移動します。
移動は以下のコマンドで行えます。

$ cd [gsht(またはgsht-arm64)をダウンロードしたフォルダのパス]

3. ダウンロードしたファイルに実行権限を与えてください。
x86_64版は
$ chmod u+x ./gsht
Arm64版は
$ chmod u+x ./gsht-arm64

4. 実行します。(初回のみモジュールのダウンロードがあるため、少し時間がかかります。)
以下のコマンドで実行できます。
x86_64版は
$ ./gsht
Arm64版は
$ ./gsht-arm64

引数の設定方法(ヘルプ画面)が表示され、終了すれば正常に動作しています。これ以降は、どのOSでも同じ操作です。使い方は以下をご覧ください。ただし、Linux版の場合は、実行時に(同じフォルダから実行する場合は)"./"を付ける必要があります。


CUI版の引数 全て
引数を表示(ヘルプ画面)

usage: 実行ファイル [-h] [-v] [-l] [-p PORT] [-p2 PORT2] [-p3 PORT3] [-i INVITEKEY] [-s SERVER] [--reset]

ゲームサーバー公開ツール CUI版 v1.0.0 (win64)

optional arguments:

-h, --help・・・show this help message and exit

-v, --version・・・show program's version number and exit

-l, --serverlist・・・公開に使用できるサーバー一覧を表示します。招待キーを同時に指定すると招待キーを適用した後のサーバー一覧が表示されます。

-p PORT, --port PORT 公開するポート番号(TCP/UDP両方)

-p2 PORT2, --port2 PORT2・・・公開するポート番号 2 (TCP/UDP両方)

-p3 PORT3, --port3 PORT3・・・公開するポート番号 3 (TCP/UDP両方)

-i INVITEKEY, --invitekey INVITEKEY・・・招待キー (任意)

-s SERVER, --server SERVER・・・招待キーを適用後のサーバー ("--serverlist --invitekey 招待キー"(招待キー指定は任意) でサーバー一覧をご覧になれます。指定しない場合は、サーバーの1番目が指定されます。)

--reset・・・アドレスをリセットしてから公開します


CUI版の使い方
以下の目的別にまとめましたので、用途に合わせてご覧ください。
(以下の例はWindows環境と仮定して行っています。実行ファイル名・指定方法はWindows、Linux共に違います。お使いの環境に合わせて変更してください。)
ポート1つを公開する(TCP/UDP・招待キーなし)

本ツールで1つのポートを公開するには、以下の通りに入力し、実行します。(注意: 公開に利用するサーバーは、1番目が自動的に選択されます。サーバーを選択したい場合は、以下の「サーバー一覧を見る・サーバーを選択する」をご覧ください。)

> gsht -p ポート番号
例↓ (ポート25565番のTCPとUDPを公開する)
> gsht -p 25565

公開されると以下のような画面になります。ここに記載してある、サーバーアドレス・ポートを利用して外部からアクセスできます。公開を終了するには、ウィンドウを×などで閉じるか、「Ctrl + C」を押します。

2, 3つのポートを同時に公開する(TCP/UDP・招待キーなし)

本ツールで2, 3つのポートを公開するには、以下の通りに入力し、実行します。この時、2つだけの場合は、-p3は省略できます。(注意: 公開に利用するサーバーは、1番目が自動的に選択されます。サーバーを選択したい場合は、以下の「サーバー一覧を見る・サーバーを選択する」をご覧ください。)

> gsht -p 1つめのポート番号 -p2 2つめのポート番号 -p3 3つめのポート番号
例↓ (ポート25565番、80番のTCPとUDPを公開する)
> gsht -p 25565 -p2 80
例↓ (ポート25565番、80番、19132番のTCPとUDPを公開する)
> gsht -p 25565 -p2 80 -p3 19132

ポートを公開する (TCP/UDP・招待キーあり)

招待キーを利用した状態で公開したい場合は、以下の通りに入力します。-p, -p2, -p3のようにポート指定をするやり方は上記と同じです。(注意: 公開に利用するサーバーは、1番目が自動的に選択されます。サーバーを選択したい場合は、以下の「サーバー一覧を見る・サーバーを選択する」をご覧ください。)

> gsht -i 招待キー -p ポート番号
例↓ (ポート25565番、80番のTCPとUDPを招待キー(xxxxxxxxxxxxxxx)を使って公開する)
> gsht -i xxxxxxxxxxxxxxx -p 25565 -p2 80

サーバー一覧を見る・サーバーを選択する

上記のように、ポートを公開する場合は、自動的にサーバーの1番目が指定されますが、サーバーを変更したい場合は、以下の引数を与えることで指定できます。(招待キーを利用している場合も同じです。)

> gsht -s サーバーID -p 25565
例↓ (ポート25565番のTCPとUDPを サーバーID: "server-1" を使って公開する)
> gsht -s server-1 -p 25565

サーバーIDは以下のコマンドで確認できます。
> gsht -l
サーバーIDを招待キーを適用した状態で確認する↓
> gsht -l -i 招待キー

サーバーアドレスをリセットして公開する

サーバーアドレスをリセットした上で公開する場合は以下のように指定します。(--reset引数を加えます。招待キーやサーバーIDも上記と同じように指定できます。)

> gsht -p 25565 --reset
例↓ (サーバーアドレスをリセットした上、ポート25565番のTCPとUDPを 招待キー(xxxxxxxxxxxxxxx)を使い、サーバーID: "server-1" を使って公開する)
> gsht -i xxxxxxxxxxxxxxx -s server-1 -p 25565 --reset


制限・注意事項など
(本ツールのダウンロード画面にある「注意・確認事項」に加えて) 不具合について
本ツールのCUI版はまだ "テスト版"となります。
そのため、不具合が残っている可能性があります。
動作しないなどの不具合がありましたら、本ツールHPの最下部にある、「問い合わせ」項目の「Discordサーバー」からコミュニティにご参加いただき、報告してくださると助かります。