囲碁GTPエンジン自動対局ツール「GoGuiTool」のページ

ホーム＞GoGuiToolのページ

囲碁GTPエンジン自動対局ツール「GoGuiTool」のページです。

GoGuiToolについて
 動作環境
 GoGuiToolの使い方
 初期設定の引き継ぎ
 GTPエンジンのリンク
 ダウンロード

GoGuiToolについて

GoGuiToolは、囲碁のGTPエンジン同士を、GoGuiとそれに含まれるgogui-twogtpなどを使って自動で対局させるためのツールです。GoGuiでの自動対局はバッチファイルを書いて実行させることもできますが、GoGuiToolを使えばバッチファイルを書かずに実行できます。

動作環境

対応OSはWindows7/8/10です。
Windows7を使っていてGoGuiToolが起動しない場合は、.NET Framework 4以上のインストールが必要になります。以下のページからインストールして下さい。
.NET Framework
Windows 8以降のOSでは.NET Framework 4以上が最初からインストールされているので、.NET Frameworkを新しくインストールする必要はありません。
GoGuiは、Zipの圧縮ファイルを展開したもので、かつ、libというフォルダの中にjarファイル（gogui.jarなど）が含まれている必要があります。Windowsのインストーラ(gogui-*.*.*-install.exe)を使ってインストールしたGoGui.exeには対応していません。
GoGuiを実行するためにはJavaも必要になります。もし入っていなければインストールしておいて下さい。

GoGuiToolの使い方

GoGuiToolの起動前に、GoGuiをダウンロードして展開しておきます。また、GTPに対応した囲碁エンジンもダウンロードして適当な場所に展開しておいて下さい。

GoGuiToolを起動するとメインウィンドウが表示されます。

●設定

「設定...」ボタンを押すと、設定ダイアログが表示されます。

設定ダイアログでは以下の項目が設定できます。

GoGuiの場所。これは対局開始前に必ず設定しなければいけません。「場所指定...」ボタンを押して、GoGuiフォルダの場所を指定して下さい。
互先のコミの初期値。
定先または置碁のコミの初期値。
この二つに関しては、メインウィンドウの「手合割」ポップアップを変更すると、コミの値がここで設定した値に変更されます。
審判用エンジンの指定。後述のエンジン管理で登録したエンジンの中から審判用のエンジンを指定できます。
これをオフにすると、対局するエンジンがそれぞれ対局結果を判定します。
これをオンにすると、対局するエンジンだけでなく、審判に指定したエンジンも対局結果を判定するので、対局するエンジンの判定と比較することができます。
使用するルールは日本式と中国式から選択できます。これは審判用エンジンに対する指定であって、対局するエンジンに対して指定しているわけではありません。
なお、審判用に使うエンジンは何でもいいわけではなく、特に、使用ルールで中国式を選ぶと、GnuGo以外のエンジンはほとんどが起動に失敗します。GnuGoであればほとんどの場合で正確に判定できると思うので、この機能を使うときはGnuGoを審判に使うようにして下さい（GnuGoをエンジンに登録するとき、引数に"--mode gtp"を入力するのを忘れないで下さい）
標準エラー出力(stderr)の内容をGTPシェルに表示するかどうか。これをオンにすると、対局中にエンジンがstderrに出力した内容をGoGuiのGTPシェルで見ることができます。
標準エラー出力(stderr)の内容をSGFファイルに保存するかどうか。これをオンにすると、対局中にエンジンがstderrに出力した内容を、対局後に保存されるSGFファイルに保存してあとで見ることができます。
通信対局のときに使うポート番号。この番号は、双方のGoGuiToolで一致していて、かつ他のソフトで使われていない番号であれば何でも構いません。デフォルト値は適当に決めたもので、特に変更する必要はないと思いますが、何かの理由で他の番号にしたければ変更して下さい。

●エンジン管理

メインウィンドウで「エンジン管理...」ボタンを押すと、エンジン管理ダイアログが表示されます。

このダイアログでエンジンの追加や削除ができます。「追加...」ボタンを押して、エンジンを選択して開くと、エンジン設定ダイアログが表示されます。

このダイアログでは、以下の項目を必要に応じて設定します。

エンジンの名前。この名前はGoGuiToolで表示する名前であり、GoGuiが対局中に表示する名前ではありません。
エンジンを起動する時に渡すコマンドライン引数。これについてはエンジン付属のREADMEなどを読んで決めて下さい。
ワーキングディレクトリ。近年公開されているエンジンの大半は、これを指定しないと起動に失敗します。そのため、GoGuiTool 1.5.0からは、エンジン登録時に、エンジンがある場所をデフォルトでワーキングディレクトリに指定するようにしました。通常はこれで問題ないと思います。
それ以外の場所を指定したい場合は「場所指定...」ボタンを押して設定して下さい。元の場所に戻したい場合は「エンジンがある場所をワーキングディレクトリに指定」ボタンを押せばすぐに元に戻すことができます。

必要な設定をしてから「登録」ボタンを押すとエンジンが登録され、エンジン管理ダイアログのエンジン一覧に追加されます。なお、登録ボタンを押した段階ではエンジンを起動しているわけではなく、単にエンジン一覧の表示に名前を追加しているだけなので、登録時の設定でエンジンが正常に動作するかどうかを確認しているわけではありません。

エンジン管理ダイアログでエンジンを選択すると、そのエンジンのパス・名前・引数・ワーキングディレクトリ(WD)が下の欄に表示されます。「設定...」ボタンを押すとエンジン設定ダイアログが表示され、設定の変更ができます。エンジンの追加と設定が終わったらエンジン管理ダイアログを閉じてメインウィンドウに戻ります。

●棋譜の保存

対局開始前に、対局の棋譜ファイルを保存する場所を指定する必要があります。まだ指定していなければ、「場所指定...」ボタンを押して、適当な場所を選択して下さい。

棋譜の保存名も決める必要があります。メインウィンドウで「保存名設定...」ボタンを押すと、保存名設定ダイアログが表示されます。

このダイアログで保存名を設定できますが、この保存名というのは、実際に保存される棋譜名そのままではないことに注意して下さい。対局を行うとき、その保存名が何であれ、GoGuiの側で自動で連番が追加されます。例えば、保存名を"game"にして連続対局をすると、 "game-0.sgf"、"game-1.sgf"、"game-2.sgf"・・・という具合に連番が追加された棋譜が保存されます。この、GoGuiの側で追加する連番というのは、このダイアログで設定できる連番とは関係ありません。

「任意入力」を選ぶと、保存名として任意の文字列を入力できます。
「対局エンジン名から自動生成」を選ぶと、対局するエンジン名から保存名を生成します。例えば、gnugo-3.8とgnugo-3.6の対局なら、"gnugo-3.8 vs gnugo-3.6"が保存名になります。通信対局の場合、使用するエンジンがgnugo-3.8で、第１局の黒番がこちら側なら、"gnugo-3.8 vs Network"が保存名になります。
「日付を入力」のチェックボックスをオンにすると、その名前の前に日付が入ります。例えば、2017年10月17日に開始した対局であれば、"20171007 gnugo-3.8 vs gnugo-3.6"が保存名になります。
「連番を追加」のチェックボックスをオンにすると、その名前のあとに連番が追加されます。ここで設定する連番というのは、対局するエンジンの組み合わせが同じであれば、一連の対局が終了するごとに増える番号のことです。
例えば、gnugo-3.8とgnugo-3.6を連番付きで対局させると、１回目の対局では連番は01となり、、その保存名は"gnugo-3.8 vs gnugo-3.6 01"となります。全ての対局が終了すると連番の数字が自動で増え、同じ組み合わせのままもう一度「対局開始」ボタンを押すと、その保存名は"gnugo-3.8 vs gnugo-3.6 02"となります。この仕組みにより、対局するエンジンの組み合わせが同じままでも、棋譜の上書きをせずに次の対局開始ができます。
対局するエンジンの組み合わせを変わると連番も01に戻ります。
日付と連番を両方とも設定することもできます。この場合、対局する日付が変わると連番も01に戻ります。

●通常対局

棋譜の保存場所と保存名を設定したら、メインウィンドウに戻り、対局の種類を選びます。
「通常対局」を選ぶと、登録したエンジンの中から２つを選んで対局させることができます。黒番エンジンと白番エンジンを選び、対局条件を設定します。

持ち時間と秒読みに関しては、エンジンによってはこの設定を無視することがあります。

「対局開始」ボタンを押すと、GoGuiが起動して対局が始まります。

連続対局が終了すると、GoGuiは「コマンドは失敗しました」というようなアラートを表示するので、それを閉じてから、GoGuiのウィンドウも閉じて終了して下さい。GoGuiを終了するまでGoGuiToolは操作できません。

GoGuiを終了するとWebブラウザが起動して対局結果の一覧を表示します。

●通信対局

２台のPCを使って通信対局させることができます。双方のPCにGoGuiとGoGuiTool、囲碁エンジンを用意してそれぞれ設定を行ってからGoGuiToolを両方とも起動します。通信対局の時は一方がサーバ側、もう一方がクライアント側となります。まず、サーバ側のGoGuiToolで「通信対局」を選び、サーバ／クライアントで「こちら側をサーバにする」を選びます。

サーバ側で設定できるのは対戦するエンジンだけで、それ以外の設定はできません。また、盤面表示や棋譜保存もできません。それらは全てクライアント側で行うことになります。対戦エンジンを選んでから右下の「対局サーバ起動」ボタンを押すと、サーバ側のPCのIPアドレスと「対局サーバ起動中」の文字が表示されます。一度この状態になると、対局が終了するまで何も操作できない状態になります。

次に、クライアント側のPCに移り、「通信対局」を選んでから、サーバ／クライアントで「こちら側をクライアントにする」を選びます。

クライアント側では対戦させるエンジンを選び、接続先のPCのIPアドレスを入力し、第１局の手番を設定します。それ以外の対局設定は通常対局と同様に行うことができます。全ての設定をしたあと、右下の「通信対局開始」ボタンを押すとサーバ側のPCと接続して対局を開始します。
対局が終了すると、通常対局と同様、GoGuiは「コマンドは失敗しました」というようなアラートを表示するので、それを閉じてからGoGuiのウィンドウも閉じて終了して下さい。GoGuiを閉じるまでGoGuiToolは操作できません。GoGuiを終了するとクライアント側ではWebブラウザが起動して対局結果一覧を表示し、サーバ側のGoGuiToolでは「対局サーバ起動中」の文字が消え、また操作できるようになります。

なお、通信対局の機能は、GoGuiのフォルダに含まれているgogui-serverとgogui-clientの機能を使って実現しているので、GoGuiToolの側では通信内容については全く関知していません。そのため、何かの原因で対局に失敗すると、その時起動したgogui-serverのプロセスが残ってしまい、次の通信対局ができなくなってしまうことがあります。そのような場合、タスクマネージャーを起動して、gogui-serverと関係ありそうなプロセス（Java(TM) Platform SE binary）を終了させて下さい。やり方がわからなければPCを再起動して下さい。

初期設定の引き継ぎ

GoGuiToolを起動してから終了すると、GoGuiToolのフォルダにはGoGuiTool.xmlという名前の初期設定ファイルが保存されています（フォルダの表示設定により、拡張子の.xmlが表示されないことがあります）。
このファイルには、GoGuiToolの設定や登録したエンジンなどの内容が保存されています。GoGuiToolの新しいバージョンをダウンロードして使うときに以前の設定を引き継ぎたいのであれば、新しいバージョンのGoGuiTool.zipを展開してフォルダを作成したあと、以前使っていたGoGuiToolのフォルダにあるGoGuiTool.xmlを新しいGoGuiToolのフォルダにコピーして下さい。

GTPエンジンのリンク

近年（２０１７年以降）に公開されたエンジンの多くはディープラーニングの手法によるもので、それらをインストールして使うには多少手間がかかります。それらのインストール方法については「囲碁やら何やら」というサイトの「囲碁AIの導入方法」というページに詳しく書かれているので、それを参考にしてください。
そこではSabakiを使ってそれらのエンジンを動かす方法が説明されていますが、GoGuiToolでのエンジン設定時、引数の欄に、Sabakiのエンジン管理での引数の欄（エンジンの登録時、初期値では「引数なし」と書いてある欄）と同じ文字列を入れると動くはずです。
Sabakiで「初期化コマンド(;-separated)」と書いてある欄には時間情報（持ち時間や秒読みの値）を入力するようですが、GoGuiToolで対局する場合は、時間情報をそれと同じような文字列に変換してしてエンジンに送るので、特に意識する必要はありません。

ダウンロード

GoGuiTool 1.5.0をダウンロード

※ダウンロードしたファイルはZipで圧縮してあるので、展開してから使って下さい。

更新履歴

2019/11/23　GoGuiTool 1.5.0リリース

エンジン登録時にエンジンがある場所をデフォルトでワーキングディレクトリに設定するように。
エンジン登録時のファイル選択ダイアログで拡張子がbatのファイルも表示するように。

2017/11/18　GoGuiTool 1.4.0リリース

通信対局の機能を追加。

2017/10/09　GoGuiTool 1.3.1リリース

棋譜の上書き確認アラートの種類を変更。
審判用エンジン起動に関する部分を少し修正。

2017/10/07　GoGuiTool 1.3.0リリース

棋譜の保存名を対局エンジン名から自動生成する機能を追加。
エンジンが標準エラー出力に出力した内容を棋譜に保存可能に。
棋譜保存場所のパスにスペースが含まれていると対局に失敗していた問題を修正。

2017/04/01　GoGuiTool 1.2.1リリース

ワーキングディレクトリのパスにスペースが含まれていると対局に失敗していた問題を修正。

2017/03/11　GoGuiTool 1.2.0リリース

審判用エンジンの指定が可能に。
エンジンが標準エラー出力に出力した内容を表示可能に。

2017/03/04　GoGuiTool 1.1.0リリース

ワーキングディレクトリの指定が可能に。
置碁の対局が可能に。
GoGuiToolで設定した内容は、GoGuiTool.exeと同じ場所にあるGoGuiTool.xmlというファイルに保存されますが、バージョン1.0.0と1.1.0では、一部互換性がないところがあります。そのため、バージョン1.0.0で保存されたGoGuiTool.xmlをバージョン1.1.0のGoGuiTool.exeと同じ場所にコピーしてから起動すると、エンジンの設定内容のうち引数の欄が全て空白になります。その場合、申し訳ありませんが引数の欄は新規に入力し直して下さい。

2012/12/22　GoGuiTool 1.0.0リリース

ホーム＞GoGuiToolのページ