search

penta2019 / mahjong_server

日本リーチ麻雀のゲームサーバー
MIT License
16 stars 2 forks source link
bot mahjong rust

readme

Mahjong Server (WIP)

概要

日本リーチ麻雀のゲームサーバーです.
主にBot同士を対戦させることを目的にしています.
Botは未実装でエンジンの動作確認のみができる状態です.
類似プロジェクト: Mjai(https://github.com/gimite/mjai)

主な機能

未実装の機能,または出来ない事

動作に必要なもの

牌の文字列表現

通常,萬子の1なら1mのように表現することが多いですが,プログラミングの命名規則や並び順の観点から本プログラムではm1のように通常と前後逆に表現しています.
萬子: m1, m2, m3, m4, m0(赤5), m5, m6, m7, m8, m9
筒子: p1, p2, p3, p4, p0(赤5), p5, p6, p7, p8, p9
索子: s1, s2, s3, s4, s0(赤5), s5, s6, s7, s8, s9
字牌: z1(東), z2(南), z3(西), z4(北), z5(白), z6(發) ,z7(中)

使い方

rustの実行環境をインストールして各種コマンドを実行してください. 依存ライブラリはコマンドの初回実行時に自動的にダウンロードされます.

対戦モード (E)

シングル実行

単一の試合を実行します.
試合状況はwebsocketを通してブラウザから確認出来ます.

オプション一覧

-s seed (デフォルト値:現在のUnixTime(秒))
    牌山生成のシード値.
-r round (デフォルト値:1)
    1: 4人東, 2: 4人南
-w
    ファイルに牌譜を出力
-w-tenhou
    ファイルに牌譜を天鳳形式で出力 (https://tenhou.net/6/)
-d
    ステップ実行. イベントを処理するごとに一時停止して表示コマンドを受け付けます.
-0 actor_name (デフォルト値: Nop)
    座席0のActor.
-1 actor_name (デフォルト値: Nop)
    座席1のActor.
-2 actor_name (デフォルト値: Nop)
    座席2のActor.
-3 actor_name (デフォルト値: Nop)
    座席3のActor.

実行例

マルチプル実行

複数の試合を実行して結果を集計します.
このモードでは入出力を行うActor(=Manual, MjaiEndpoint)は使用できません.
各actorの座席は試合開始時にランダムで決定されます.

オプション一覧

-s seed (デフォルト値:現在のUnixTime(秒))
    牌山生成のシード値を生成するためのマスターのシード値.
-r round (デフォルト値:1)
    1: 4人東, 2: 4人南
-g n_game (必須)
    実行数する試合の数.このオプションを指定しない場合シングル実行になります.
-t n_thread (デフォルト値:16)
    同時に実行するスレッド(試合)の数.
-0 actor_name (デフォルト値: Nop)
    座席0のActor.
-1 actor_name (デフォルト値: Nop)
    座席1のActor.
-2 actor_name (デフォルト値: Nop)
    座席2のActor.
-3 actor_name (デフォルト値: Nop)
    座席3のActor.

実行例

雀魂自動操作モード (J)

本体を起動した後,ゲーム画面の開発コンソールを開いて本体のwebsocketサーバに接続します.

オプション一覧

-r
    読み込み専用モード.このモードではActorが指定した操作(雀魂の自動操作)を行いません.
-s
    操作(ロン,ツモ,キャンセルを除く)を行う前にランダム時間スリープします.最大4秒
-w
    局終了時にイベントデータを/data/[unixtime].jsonに保存します.  
-wr
    局終了時に生のイベントデータを/data_raw/[unixtime].jsonに保存します. 
-msc-port port (デフォルト値:52000)
    雀魂側のスクリプトから接続するためのwsサーバのポート
-0 actor_name (必須)
    使用するActor(AI).

実行例

ゲーム側から本体への接続
ブラウザにtampermonkeyなどのユーザースクリプト実行プラグインをインストールして/script/mahjong_soul.jsの中身を貼り付けます.
tampermonkeyの場合,行頭のコメントを自動で読み取って設定を反映します.
正しくインストールされていれば,ゲームページからブラウザの開発コンソール画面を開いて以下のメッセージが確認できるはずです.

[MSC] MSC is enabled

この状態ではまだ本体と接続していないので以下のコマンドを実行してください.
このコマンドは未接続の時に本体のwsサーバ(127.0.0.1:52000)に対して定期的に接続を試みます.

> msc.server.run_forever(52000);

段位戦を自動でループするには以下のコマンドを実行します arg 0: 0: 胴の間, 1: 銀の間, 2: 金の間 arg 1: 0: 4人東, 1: 4人南

> msc.ui.enable_auto_match(1, 0);

牌譜リプレイモード (R)

E, J モードの-wオプションでファイルに書き出した牌譜(json)を読み込んで再生します. 主にデバッグ用

オプション一覧

-f
    再生する牌譜のファイルパス
    ディレクトリを指定した場合,そのディレクトリ内に存在するすべてのjsonファイルを順番に読み込みます.
-s round[,dealer[,honba_sticks]]
    -fでディレクトリを指定した際に,-sで指定した局までスキップします.
    例) -s 0,1,3 東2局3本場までスキップ
-d
    ステップ実行. イベントを処理するごとに一時停止して表示コマンドを受け付けます.

手役計算モード (C)

フォーマットの詳細についてはtests/win_hands.txtを参照してください.

オプション一覧

-d
    詳細を表示
-f
    ファイル内のデータをまとめて読み込み

Actor

Actorとはゲームの操作を行う主体(Bot)のことです.
オプションを指定可能なActorの場合, Actor(arg1,arg2,...)のように順番に引数で指定します.
後側の引数は省略可能ですべての引数を省略する場合は()は不要です. 省略した引数はデフォルト値が使用されます.

現在実用的なAIは実装できていませんが,Mjaiプロトコルに対応した外部AIを使用することが出来ます.
ソースコードは /src/actor の下に配置されています.

Manual Actorの操作方法

可能な操作をエンジン側が提示するのでaction indexを指定します.
例外として打牌(Discard)の場合は直接,牌のシンボルを指定します.
Discardに渡されるリストは鳴きの後に捨てることが出来ない牌(面子の組み換え禁止)です.
以下に具体例を示します.

[Turn Action] select tile or action 0 => Action(Nop, []) 1 => Action(Discard, [])

p1


* 鳴き: 上家が捨てたp3をp4,p5でチー

seat: 0, score: 25000, riichi: None, nukidora: 0, drawn: None furiten: false, furiten_other: false, rinshan: false, winning_tiles: [] hand: m1 m3 m4 m6 m8 p4 p5 s1 s2 s3 s5 s5 s6 melds: discards: s7 p1

[Call Action] select action 0 => Action(Nop, []) 1 => Action(Chi, [Tile(1, 4), Tile(1, 5)])

1

可能な操作一覧 (/src/util/actor.rs から抜粋)

pub enum Action {
    Nop,           // キャンセル (鳴き,ロンのスキップ)
    Discard,       // 打牌 (配列はチー後に捨てることができない牌)
    Chi,           // チー (配列は鳴きが可能な組み合わせ 以下同様)
    Pon,           // ポン
    Ankan,         // 暗槓
    Minkan,        // 明槓
    Kakan,         // 加槓
    Riichi,        // リーチ
    Tsumo,         // ツモ
    Ron,           // ロン
    Kyushukyuhai,  // 九種九牌
    Nukidora,          // 北抜き
}

動作確認済みOS

コーディング規約

命名規則

基本的に麻雀英語wikiの表記に従いますが,役の名称はすべて日本語で統一します.

変数名省略

n: number of i: index of d_: delta of stg: stage
ti: Tile type index
ni: Tile number index
s: seat
t: tile
e: event
c: count

Module構成

Module図