diff options
Diffstat (limited to 'src/docs')
| -rw-r--r-- | src/docs/reversi-bot.ja.md | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/src/docs/reversi-bot.ja.md b/src/docs/reversi-bot.ja.md index 6fe62003df..98b543ca6c 100644 --- a/src/docs/reversi-bot.ja.md +++ b/src/docs/reversi-bot.ja.md @@ -1,15 +1,15 @@ # MisskeyリバーシBotの開発 Misskeyのリバーシ機能に対応したBotの開発方法をここに記します。 -1. `reversi`ストリームに以下のパラメータを付けて接続する: +1. `games/reversi`ストリームに以下のパラメータを付けて接続する: * `i`: botアカウントのAPIキー 2. 対局への招待が来たら、ストリームから`invited`イベントが流れてくる * イベントの中身に、`parent`という名前で対局へ誘ってきたユーザーの情報が含まれている -3. `reversi/match`へ、`user_id`として`parent`の`id`が含まれたリクエストを送信する +3. `games/reversi/match`へ、`user_id`として`parent`の`id`が含まれたリクエストを送信する -4. 上手くいくとゲーム情報が返ってくるので、`reversi-game`ストリームへ、以下のパラメータを付けて接続する: +4. 上手くいくとゲーム情報が返ってくるので、`games/reversi-game`ストリームへ、以下のパラメータを付けて接続する: * `i`: botアカウントのAPIキー * `game`: `game`の`id` @@ -96,8 +96,8 @@ y = Math.floor(pos / mapWidth) フォームコントロールは、次のようなオブジェクトです: ```javascript { - id: 'button1', - type: 'button', + id: 'switch1', + type: 'switch', label: 'Enable hoge', value: false } @@ -110,21 +110,21 @@ y = Math.floor(pos / mapWidth) ### フォームの操作を受け取る ユーザーがフォームを操作すると、ストリームから`update-form`イベントが流れてきます。 イベントの中身には、コントロールのIDと、ユーザーが設定した値が含まれています。 -例えば、上で示したボタンをユーザーがオンにしたとすると、次のイベントが流れてきます: +例えば、上で示したスイッチをユーザーがオンにしたとすると、次のイベントが流れてきます: ```javascript { - id: 'button1', + id: 'switch1', value: true } ``` ### フォームコントロールの種類 -#### ボタン -type: `button` -ボタンを表示します。何かの機能をオン/オフさせたい場合に有用です。 +#### スイッチ +type: `switch` +スイッチを表示します。何かの機能をオン/オフさせたい場合に有用です。 ##### プロパティ -`desc` ... ボタンの詳細な説明。 +`desc` ... スイッチの詳細な説明。 #### ラジオボタン type: `radio` @@ -145,6 +145,15 @@ items: [{ }] ``` +#### スライダー +type: `slider` +スライダーを表示します。 + +##### プロパティ +`min` ... スライダーの下限。 +`max` ... スライダーの上限。 +`step` ... 入力欄で刻むステップ値。 + #### テキストボックス type: `textbox` テキストボックスを表示します。ユーザーになにか入力させる一般的な用途に利用できます。 @@ -163,3 +172,6 @@ type: `textbox` } ``` メッセージの種類: `success`, `info`, `warning`, `error`。 + +## 投了する +投了をするには、<a href="./api/endpoints/games/reversi/games/surrender">このエンドポイント</a>にリクエストします。 |