Skip to content

Commit

Permalink
Documented the /draw command
Browse files Browse the repository at this point in the history
  • Loading branch information
programarivm committed Oct 11, 2023
1 parent 16d0fa6 commit d144025
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/draw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# /draw

## Description

Allows to draw a game.

## Parameters

| Name | Description | Required |
| ---- | ----------- | -------- |
| action | Accepts: propose, accept | Yes |

## Usage

### Propose a draw

```js
ws.send('/draw propose');
```

```text
{
"/draw": "propose"
}
```

### Accept a draw

```js
ws.send('/draw accept');
```

```text
{
"/draw": "accept"
}
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ pages:
- /heuristics: heuristics.md
- /undo: undo.md
- /accept: accept.md
- /draw: draw.md
- /restart: restart.md
theme: readthedocs

0 comments on commit d144025

Please sign in to comment.