https://github.com/na2hiro/Kifu-for-JS/tree/master/packages/json-kifu-format
JSONで将棋の棋譜を取り扱う標準形式JKFを定義しています．またJKFを既存のKIF, KI2, CSA等から変換するライブラリ及びJKFを用いて盤面再生を行うライブラリを提供します．
- 現状の問題として，既存のKIF, KI2, CSA形式が持つ情報はバラバラであり，アプリケーション側の対応に手間がかかる．
- 上記形式の情報に加え，棋譜再生や表示に必要な情報を持った形式をJSONで表し，これを流通用の JSON棋譜フォーマット(JKF) とする．
- JKFが一般的になれば，棋譜再生を行うアプリケーションの作成が容易になる．
- 一例として，JKFを元に棋譜再生を行うJKFPlayerクラス(JavaScript)を提供する．
- KIF, KI2, CSA各形式のパーサ(JavaScript)を用意し，JKFへ変換できるようにする．
- これはパーサジェネレータによるパーサである．つまり， KIF, KI2, CSA形式のEBNF表現 を提供している．これは将棋界において画期的である．
| フォーマット | KIF | KI2 | CSA | JKF |
|---|---|---|---|---|
| 0) 1) 元座標(from) | ○ | △(要相対逆算) | ○ | ○ |
| 1) 取った駒(capture) | × | × | × | ○ |
| 1) 2) 成り(promote) | ○(不成なし) | ○ | △ | ○ |
| 2) 相対情報(relative) | △ | ○ | △ | ○ |
| 2) 同〜(same) | ○ | ○ | × | ○ |
| 手番(color) | × | ○ | ○ | ○ |
| 消費時間(time) | ○ | × | ○ | ○ |
○=棋譜だけで可能 △=現在の局面を見れば可能 ×=不可能か，以前の局面を見れば可能
- 0: 局面を1手進めるために必要な情報
- 1: 局面を1手戻すために必要な情報
- 2: 可読棋譜にするために必要な情報
- 相対情報: 上下左右など，同じ座標に複数の駒が移動できる場合に駒を区別するための情報．
- 相対逆算: 局面と座標と相対情報から，その位置に移動する駒を特定すること．
以下で定義される形式をVersion 1.0とします．1.x台では後方互換性を保つ変更のみを採用します． (TypeDoc も参照)
./src/Formats.tsにある内容です．"?"はない場合があるという意味です．小文字で始まる型名は組み込み型です．
- JKFが持つフィールドの定義
- header
string=>stringヘッダ情報．キーはKI2，KIF等の日本語のものに準ずる．(例: "場所", "先手") - initial? 初期局面(なければ平手)
- preset
InitialPresetString手合名 - data? 初期局面データ(手合名がOTHERの時に使用)
- color:
Color初手の手番 - board:
以下[][]board[x-1][y-1]に(x,y)の駒情報．駒がない場合は空オブジェクト{}- color?:
Color先手/後手 - kind?:
string駒の種類
- color?:
- hands:
(string=>number)[]駒種がkey, 枚数がvalueの連想配列．0番目が先手，1番目が後手の持駒
- color:
- preset
- moves
MoveFormat[]n番目はn手目の棋譜(0番目は初期局面のコメント用)
- header
上の定義で使うオブジェクトの補助定義は次の通り．
MoveFormat指し手を表す- comments?
string[]コメント - move? 駒の動き
- color
Color先手/後手 - from?
PlaceFormat移動元 打った場合はなし - to
PlaceFormat移動先 - piece
string駒の種類(FUKY等のCSA形式) - same?
boolean直前と同じ場合 - promote?
Bool成るかどうか true:成, false:不成, 無いかnull:どちらでもない - capture?
string取った駒の種類 - relative?
RelativeString相対情報
- color
- time? 消費時間
- now
TimeFormat1手 - total
TimeFormat合計
- now
- special?
string特殊棋譜(CSAのTORYO, CHUDAN等) - forks?
MoveFormat[][]任意の長さの分岐を任意個格納する．分岐の初手はこのforksを持つ棋譜の代替の手とする(次の手ではなく)
- comments?
TimeFormat時間を表す- h?
Integer時 - m
Integer分 - s
Integer秒
- h?
PlaceFormat座標を表す- x
Integer1から9 - y
Integer一から九
- x
エイリアスは次の通り．
Color = number陣営を表す． 先手: 0, 後手: 1RelativeString = string以下の文字列を連結したもの- 左, 直, 右: それぞれL, C, R(Left, Center/Choku, Right)
- 上, 寄, 引: それぞれU, M, D(Up, Middle, Down)
- 打: H(Hit (本来はDrop))
InitialPresetString = string平手，香落ち等KIFでサポートされている手合情報- HIRATE: 平手
- KY: 香落ち
- KY_R: 右香落ち
- KA: 角落ち
- HI: 飛車落ち
- HIKY: 飛香落ち
- 2: 二枚落ち
- 3: 三枚落ち
- 4: 四枚落ち
- 5: 五枚落ち
- 5_L: 左五枚落ち
- 6: 六枚落ち
- 7_L: 左七枚落ち
- 7_R: 右七枚落ち
- 8: 八枚落ち
- 10: 十枚落ち
- OTHER: その他
JSONで一般的なUTF-8を使用するものとします．
JSON Schema のバージョン 2020-12 による定義が ./specification/json-kifu-format.schema.json にあります。
また、 npm run schema:compile によりこのJSON Schemaファイル自体の検証を、 npm run schema:validate により specification/files/ 以下にあるJKFファイルのJSON Schemaファイルに対する検証を行います。
.test/ 以下にも例が載っています．
{
"header": {
"先手": "na2hiro",
"後手": "うひょ"
},
"moves": [
{},
{"move":{"from":{"x":7,"y":7},"to":{"x":7,"y":6},"color":0,"piece":"FU"}},
{"move":{"from":{"x":3,"y":3},"to":{"x":3,"y":4},"color":1,"piece":"FU"}},
{"move":{"from":{"x":8,"y":8},"to":{"x":2,"y":2},"color":0,"piece":"KA","capture":"KA","promote":false}},
{"move":{"from":{"x":3,"y":1},"to":{"x":2,"y":2},"color":1,"piece":"GI","capture":"KA","same":true}},
{"move":{"to":{"x":4,"y":5},"color":0,"piece":"KA"}},
{"special": "CHUDAN"}
]
}{
"header": {},
"moves": [
{"comments":["分岐の例"]},
{"move":{"from":{"x":7,"y":7},"to":{"x":7,"y":6},"color":0,"piece":"FU"}},
{"move":{"from":{"x":3,"y":3},"to":{"x":3,"y":4},"color":1,"piece":"FU"}, "comments":["次の手で二種類が考えられる：７七桂か２二角成である．","２二角成を選ぶと筋違い角となる．"]},
{"move":{"from":{"x":8,"y":9},"to":{"x":7,"y":7},"color":0,"piece":"KE"}, "forks":[
[
{"move":{"from":{"x":8,"y":8},"to":{"x":2,"y":2},"color":0,"piece":"KA","capture":"KA","promote":false}},
{"move":{"from":{"x":3,"y":1},"to":{"x":2,"y":2},"color":1,"piece":"GI","capture":"KA","same":true}},
{"move":{"to":{"x":4,"y":5},"color":0,"piece":"KA"}}
]
]},
{"move":{"from":{"x":2,"y":2},"to":{"x":7,"y":7},"color":1,"piece":"KA","capture":"KE","promote":true,"same":true}},
{"move":{"from":{"x":8,"y":8},"to":{"x":7,"y":7},"color":0,"piece":"KA","capture":"UM","same":true}},
{"move":{"to":{"x":3,"y":3},"color":1,"piece":"KE","relative":"H"}}
]
}{
"header": {},
"initial": {"preset": "6"},
"moves": [
{},
{"move":{"from":{"x":5,"y":1},"to":{"x":4,"y":2},"color":1,"piece":"OU"}},
{"move":{"from":{"x":7,"y":7},"to":{"x":7,"y":6},"color":0,"piece":"FU"}},
{"move":{"from":{"x":6,"y":1},"to":{"x":7,"y":2},"color":1,"piece":"KI"}}
]
}{
"header": {},
"initial": {
"preset": "OTHER",
"data": {
"board": [
[{"color":1, "kind":"KY"}, { },{"color":1, "kind":"FU"}, {}, {}, {}, {"color":0, "kind":"FU"}, { }, {"color":0, "kind":"KY"}],
[{"color":1, "kind":"KE"}, {"color":1, "kind":"KA"},{"color":1, "kind":"FU"}, {}, {}, {}, { }, {"color":0, "kind":"HI"}, {"color":0, "kind":"KE"}],
[{"color":1, "kind":"GI"}, { },{"color":1, "kind":"FU"}, {}, {}, {}, {"color":0, "kind":"FU"}, { }, {"color":0, "kind":"GI"}],
[{"color":1, "kind":"KI"}, { },{"color":1, "kind":"FU"}, {}, {}, {}, {"color":0, "kind":"FU"}, { }, {"color":0, "kind":"KI"}],
[{"color":1, "kind":"OU"}, { },{"color":1, "kind":"FU"}, {}, {}, {}, {"color":0, "kind":"FU"}, { }, {"color":0, "kind":"OU"}],
[{"color":1, "kind":"KI"}, { },{"color":1, "kind":"FU"}, {}, {}, {}, {"color":0, "kind":"FU"}, { }, {"color":0, "kind":"KI"}],
[{"color":1, "kind":"GI"}, { },{"color":1, "kind":"FU"}, {}, {}, {}, { }, { }, {"color":0, "kind":"GI"}],
[{"color":1, "kind":"KE"}, {"color":1, "kind":"HI"},{"color":1, "kind":"FU"}, {}, {}, {}, {"color":0, "kind":"FU"}, {"color":0, "kind":"KA"}, {"color":0, "kind":"KE"}],
[{"color":1, "kind":"KY"}, { },{"color":1, "kind":"FU"}, {}, {}, {}, {"color":0, "kind":"FU"}, { }, {"color":0, "kind":"KY"}]
],
"color": 0,
"hands":[
{"FU":0,"KY":0,"KE":0,"GI":0,"KI":0,"KA":0,"HI":0},
{"FU":0,"KY":0,"KE":0,"GI":0,"KI":0,"KA":0,"HI":0}
]
}
},
"moves": [
{"comments": ["飛車角先落ち．"]},
{"move":{"from":{"x":2,"y":8},"to":{"x":2,"y":3},"color":0,"piece":"HI","promote":true,"capture":"FU"}}
]
}Releases からどうぞ．json-kifu-format-*.*.*.min.jsを読み込むと，JSONKifuFormat が使えるようになります．
$ npm install json-kifu-formatexportされているクラス群は次の通りです
ParsersparseKIF: KIFをJSON形式に一対一変換するパーサparseKI2: KI2をJSON形式に一対一変換するパーサparseCSA: CSA(V1, V2, V2.1, V2.2)をJSON形式に一対一変換するパーサ
Normalizer: {KIF/KI2/CSA}と同等の情報しか持たないJKFを完全なJKFに変換するプログラムJKFPlayer: JKFを扱う棋譜再生盤の例
$ nvm use && nvm i && npm i上記コマンドを実行することで開発に必要なパッケージをインストールできます．
- na2hiro/Shogi.js: 将棋の盤駒を扱うライブラリ
- PEG.js: パーサジェネレータ
- TypeScript
- Webpack
- Jest
- ESLint
$ npm run build
$ npm run build:watch
$ npm run build:analyzeビルドが走ります．build:watchの場合，変更されるたびにビルドが走ります．build:analyzeの場合，バンドルの大きさの可視化ができます．
$ npm run test:watchコンソールでテスト結果が表示されます．コードの変更が保存されるたびに必要なテストが再実行されるため，実装が既存の有効なテストを壊してないか簡単に確認できます．
$ npm run test全てのテストが走るとともにカバレッジレポートが表示されます．coverage/lcov-report/index.htmlでは，行ごとのカバレッジを確認できます．追加されたコードのブランチカバレッジが100%になるようにしてください．push時にチェックされ満たしていなければ却下されるはずです．
$ npm run lintコードの品質が検査されます．エラーがあればそれに従い直してください．push前にもチェックされます．
$ npm run lint:fix自動的に修正可能な問題(インデント等)を直してくれます．
issues 参照． 読み込みエラーとなる棋譜があったら教えて下さい．
- CSA標準棋譜ファイル形式
- shogi-format: こちらは昔自ら提案したもの．大風呂敷だったため挫折しました．今回はより小さく洗練された形式を目指しており，また実装を用意し実用第一で進めていきます．
- 棋譜の表記方法: 相対情報の書き方
- 棋譜の形式について - 将棋の棋譜でーたべーす: 出回っている棋譜形式のまとめ
MIT License (see ./LICENSE.txt)
- Bump version using
bumpaction - Create a new release with the new version
- Check an email about publish result
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent