API for experiment script - xeejp/xee3rd-legacy GitHub Wiki

はじめに

以下で単にDATAと書いた時、それは実験内で取り回されるデータを示します。
また、STUDENT_DATAは学生用テンプレートに渡されるデータ、
TEACHER_DATAは教師用テンプレートに渡されるデータを示します。

スクリプトの呼び出し形式

システムは実行時引数をつけてスクリプトを実行します
例:python main.py init

API一覧

実行時引数のつけ方は以下の3つがあります。

name 実効時引数 説明
init init ゲーム作成時に呼ばれる
join join DATA ID 新しい学生が参加したら呼ばれる
receive receive DATA RECEIVED_DATA [ID] ブラウザからデータが送られてきた時に呼ばれる 学生からの時はIDも渡される

出力形式

以下のようなjsonデータを返してください。

{
    "data": DATA,
    "host": TEACHER_DATA,
    "participant": {STUDENT_ID: STUDENT_DATA, ...}
}