棋譜の仕様を文書化

mikarru commented 6 years ago

棋譜の仕様を文書化しました。以下のようなことについてコメントしてもらえるとありがたいです。

棋譜の仕様
文書での説明の仕方
typo等あれば

sash2104 commented 6 years ago

ありがとう！説明丁寧でわかりやすかったし、仕様もきちっと決まってて良いね。

sash2104 commented 6 years ago

気になったのは細かい部分ばっかなんだけど、

infoに持ち時間、勝者、最終得点あたりは (任意で) 含めても良いかも
XXX_PLACEMENTのXXXに当たる単語の使われ方が統一されてないのが若干きになる...
- firstは形容詞、skipは動詞、playerとtileとmeepleは名詞 (playerはPLACEMENTする対象、tileとmeepleはPLACEMENTされる対象)
似た理由で、action (動作) が、skipPlace、playerPlace、firstPlaceで動作を表してないのも気になる

とはいっても代わりになる良い命名が思い浮かばないからちょっと考える

sash2104 commented 6 years ago

action -> type
first -> initial (初期配置の英語がinitial placementのほうが使われてそう)
skip -> skipped or illegal (ルールのpdfで、 "no legal" な配置の場合はタイルを捨てる、とあるのでlegal使ってみた)
player -> ordinary or regular or default

sash2104 commented 6 years ago

書いてて、細かい部分を気にしすぎな気がしてきた。ひとまずは、typoの修正だけしたらmergeしちゃって良いと思う

mikarru commented 6 years ago

@sash2104 コメントありがとう！

infoは他にも色々含められるなと思いつつ、ちゃんと考えるの面倒なので放置してました。持ち時間、勝者、最終得点あたりは、結構大事な情報だからここで加えときます。

{
  "info": {
    "winner": "プレイヤー1",
    "finalPoint": {"プレイヤー1": 89, "プレイヤー2": 78},
    "allottedTime": 15 // 単位は分
  }
}

みたいな感じ？同点の場合どうしよー？同点でも盤外の規則で勝敗が決まるんやったらこのままでもいいけど、勝敗なしの場合とか。ちょっと違和感あるかもしれんけど、"winner"の値をarrayにして、通常は要素を一つだけ持って、同点で勝者なしの場合は要素なしにするとか。得点はscoreでなくてpointでOK?(説明書ではscoreは"得点を得る"って意味で使わてることが多いっぽい) ちょっと細かいけど、infoの得点がplacementsを実行していって計算できた得点と違う場合どうしよか？今はそういう場合は放置でいいかな…笑

infoに持ち時間含めるんやったらPLACEMENTに使った時間があった方が良いかもしれんな

{
  "action": "playerPlace",
  "elapsedTime": 13 // 単位は秒
}

mikarru commented 6 years ago

@sash2104

action -> type first -> initial

OK!

skip -> skipped or illegal

skippedの方がいいかな。こっちの方がわかりやすい気がする。

player -> ordinary or regular or default

regularで！

sash2104 commented 6 years ago

@mikarru

同点の場合どうしよー？同点でも盤外の規則で勝敗が決まるんやったらこのままでもいいけど、勝敗なしの場合とか。ちょっと違和感あるかもしれんけど、"winner"の値をarrayにして、通常は要素を一つだけ持って、同点で勝者なしの場合は要素なしにするとか。

んーそこまで考えてなかった。"winner"をarrayにする案はいい気がする。二人戦しか考えてないけど、多人数戦だと複数人が同点で同率の勝者になることとかもあるし。

得点はscoreでなくてpointでOK?(説明書ではscoreは"得点を得る"って意味で使わてることが多いっぽい)

scoreは適当につけたからpointでいいよ！

ちょっと細かいけど、infoの得点がplacementsを実行していって計算できた得点と違う場合どうしよか？今はそういう場合は放置でいいかな…笑

とりあえず放置で...笑

infoに持ち時間含めるんやったらPLACEMENTに使った時間があった方が良いかもしれんな

そうね、任意で使った時間いれてよさそう

mikarru commented 6 years ago

@sash2104 修正しました。確認お願いします。

sash2104 commented 6 years ago

良さそうなのでマージします！

sash2104 / carcassonne

棋譜の仕様を文書化 #1