sotetsuk commented 3 years ago

方針

まず河からやっていくのがいい

データの形式

いったん Observation を想定

データの型は proto ファイルというので定義されている https://github.com/mjx-project/mjx/blob/master/mjx.proto

データの例

jsonファイル https://github.com/mjx-project/mjx/blob/master/tests/resources/json/2010091009gm-00a9-0000-83af2648%26tw%3D2.json
- これは各行が一局に対応
- 全て見えているので、Stateとなっています
- Observationは、見えてないものがある
- 実際に与えられるデータは、局の最後まで終わってるものばかりではなく、 EventHistory が途中で終わっている
天鳳でのGUIによる牌譜 https://tenhou.net/0/?log=2010091009gm-00a9-0000-83af2648&tw=2

データのロードの仕方

mjx-py のフォルダの下で作業
データの構造が mjx-py/mjxproto の下で定義されている
上のファイルを保存しておいて普通に文字列として一行ずつ読み込む
必要なライブラリをインストールして（python protocol bufferとかで検索）

例: main.py

import mjxproto
import json
from google.protobuf import json_format

d = json.loads(line)  # line は文字列
state = json_format.ParseDict(d, mjxproto.State())
print(state)

仕様

rich を使う
下記のように4列に分けて可視化する
左から東家...北家
捨て牌が6牌毎に折り返しで表示される
捨て牌の上に手牌が表示される
- 自分の場合 or Stateの場合は全てみえる
- Observationで他家の場合は鳴いた牌のみ見える。残りは後ろ向き

リンク

文字コード一覧: https://github.com/mjx-project/mjx/blob/master/mjx/tile.cpp#L275
Rich: https://github.com/willmcgugan/rich

OkanoShinri commented 3 years ago

念のため今日発生したトラブルを記録
- package内のimportにimplicit relative importは使えない(https://qiita.com/ysk24ok/items/2711295d83218c699276#package%E5%86%85%E3%81%AEimport%E3%81%ABimplicit-relative-import%E3%81%AF%E4%BD%BF%E3%81%88%E3%81%AA%E3%81%84)

sotetsuk commented 3 years ago

betterproto を使うようになったので、 from_json や to_json とかが使える

https://github.com/danielgtaylor/python-betterproto

@OkanoShinri

sotetsuk commented 3 years ago

イメージ図

12006C34-8835-4E67-A764-E120863CB437

sotetsuk commented 3 years ago

ユニコードの表示のされ方の実験

to_unicode = {
    0: "\U0001F007",
    1: "\U0001F008",
    2: "\U0001F009",
    3: "\U0001F00A",
    4: "\U0001F00B",
    5: "\U0001F00C",
    6: "\U0001F00D",
    7: "\U0001F00E",
    8: "\U0001F00F",
    9: "\U0001F019",
    10: "\U0001F01A",
    11: "\U0001F01B",
    12: "\U0001F01C",
    13: "\U0001F01D",
    14: "\U0001F01E",
    15: "\U0001F01F",
    16: "\U0001F020",
    17: "\U0001F021",
    18: "\U0001F010",
    19: "\U0001F011",
    20: "\U0001F012",
    21: "\U0001F013",
    22: "\U0001F014",
    23: "\U0001F015",
    24: "\U0001F016",
    25: "\U0001F017",
    26: "\U0001F018",
    27: "\U0001F000",
    28: "\U0001F001",
    29: "\U0001F002",
    30: "\U0001F003",
    31: "\U0001F006",
    32: "\U0001F005",
    33: "\U0001F004",
}

for k, v in to_unicode.items():
    print(v)

print("🀄")
print("🀄︎")

sotetsuk commented 3 years ago

Mac

iterm

Terminal

Notes

PyCharm

sotetsuk commented 3 years ago

異文字セレクタを使うことでだいたいの場合うまいこといった

to_unicode = {
    0: "\U0001F007",
    1: "\U0001F008",
    2: "\U0001F009",
    3: "\U0001F00A",
    4: "\U0001F00B",
    5: "\U0001F00C",
    6: "\U0001F00D",
    7: "\U0001F00E",
    8: "\U0001F00F",
    9: "\U0001F019",
    10: "\U0001F01A",
    11: "\U0001F01B",
    12: "\U0001F01C",
    13: "\U0001F01D",
    14: "\U0001F01E",
    15: "\U0001F01F",
    16: "\U0001F020",
    17: "\U0001F021",
    18: "\U0001F010",
    19: "\U0001F011",
    20: "\U0001F012",
    21: "\U0001F013",
    22: "\U0001F014",
    23: "\U0001F015",
    24: "\U0001F016",
    25: "\U0001F017",
    26: "\U0001F018",
    27: "\U0001F000",
    28: "\U0001F001",
    29: "\U0001F002",
    30: "\U0001F003",
    31: "\U0001F006",
    32: "\U0001F005",
    33: "\U0001F004\uFE0E",
}

for k, v in to_unicode.items():
    print(v)

[ ] Windowsではどうなる？

sotetsuk commented 3 years ago

from rich.table import Table
from rich.console import Console
from rich import print

to_unicode = {
    0: "\U0001F007",
    1: "\U0001F008",
    2: "\U0001F009",
    3: "\U0001F00A",
    4: "\U0001F00B",
    5: "\U0001F00C",
    6: "\U0001F00D",
    7: "\U0001F00E",
    8: "\U0001F00F",
    9: "\U0001F019",
    10: "\U0001F01A",
    11: "\U0001F01B",
    12: "\U0001F01C",
    13: "\U0001F01D",
    14: "\U0001F01E",
    15: "\U0001F01F",
    16: "\U0001F020",
    17: "\U0001F021",
    18: "\U0001F010",
    19: "\U0001F011",
    20: "\U0001F012",
    21: "\U0001F013",
    22: "\U0001F014",
    23: "\U0001F015",
    24: "\U0001F016",
    25: "\U0001F017",
    26: "\U0001F018",
    27: "\U0001F000",
    28: "\U0001F001",
    29: "\U0001F002",
    30: "\U0001F003",
    31: "\U0001F006",
    32: "\U0001F005",
    33: "\U0001F004\uFE0E",
}

all_tiles = [v for k, v in to_unicode.items()]

console = Console()

table = Table(show_header=True, header_style="bold magenta")
table.add_column("East", justify="center")
table.add_column("South", justify="center")
table.add_column("West", justify="center")
table.add_column("North", justify="center")
table.add_row(
    " ".join(all_tiles[:6]),
    " ".join(all_tiles[6:12]),
    " ".join(all_tiles[12:18]),
    " ".join(all_tiles[18:24]),
)
table.add_row(
    " ".join(all_tiles[:6]),
    " ".join(all_tiles[6:12]),
    " ".join(all_tiles[12:18]),
    " ".join(all_tiles[18:24]),
)
table.add_row(
    " ".join(all_tiles[:6]),
    " ".join(all_tiles[6:12]),
    " ".join(all_tiles[12:18]),
    " ".join(all_tiles[18:24]),
)
table.add_row(
    " ".join(all_tiles[:6]),
    " ".join(all_tiles[6:12]),
    " ".join(all_tiles[12:18]),
    " ".join(all_tiles[18:24]),
)
console.print(table)

sotetsuk commented 3 years ago

方向性

From #667

全体の設計方針として次の２つのパートを用意する

[1] mjxproto.Observation (or State )から表示しやすく加工されたオブジェクト（例えば Board とする）にパースをするパート

e.g., board = Board.from_proto()

[2] 上記の Board オブジェクトを（キレイに）表示するパート

e.g., board.show() or board.print()

このPRでは [2] だけに集中してください。データ例としてjsonのデータも提供しましたが、Board オブジェトのデータはダミーで適当に用意してもらう形が好ましいです。 [1] は後でテストを用意しつつ書きます

ちょっと方向性が混乱してきている気がするので、方向性を決めます。

[2] も、次のパターンを考えます

richを使う[w/ rich]/使わない[w/o rich]

unicodeを使う[w/ unicode]/使わない[u/o unicode]

よって次の4パターンが存在

[A: w/rich, w/ unicode]: 一番重要。これに時間を使う予定。

[B: w rich, w/o unicode] : 重要でない。

[C: w/o rich, w/ unicode] : 重要でない。

[D: w/o rich, w/o unicode] : 二番目に重要。ただし時間を使う必要はない。テスト用途で雑な可視化を確認すれば良い。

ちょっとタスクの切り分けが大きくなりすぎてしまったので、まず、このPRでDだけ実装して、僕のレビューを経てマージするようにしましょう。

まとめると、このPRで実装するパートは

[ ] 可視化用にパースされたデータを保持するBoardクラス（名前は何でもよい）

[ ] Boardクラスを可視化するメソッド（上記のDパターンのみ実装）

sotetsuk commented 3 years ago

[x] w/o rich, w/ unicode で牌同士の間にスペースを入れて見た目を改善 (en/ja と unicode あるなしの4パターンの出力を貼って終了）
[x] richでどの機能を使って完成させるのか検証をする
- [x] テーブル（埋め込み）
- [x] その場でのflush
[x] w/ rich のデザイン案を２つ用意する
[x] w/ rich の手牌、捨て牌部分だけ実装してみる

OkanoShinri commented 3 years ago

https://github.com/mjx-project/mjx/pull/667 と同じ例を用いて手牌、捨て牌部分を実装しています。

スクリーンショット 2021-04-27 211018

このコード辺りからPRを作っていくべきでしょうか？

OkanoShinri commented 3 years ago

[x] 中央にplayerの情報（wind、起家など）を表示させる
[x] 手牌に中が来たときどうするか

mjx-project / mjx

CUIでのState・Observationの可視化 #665

方針

データの形式

データの例

データのロードの仕方

仕様

リンク

イメージ図

ユニコードの表示のされ方の実験

Mac

iterm

Terminal

Notes

PyCharm

方向性