Skip to content

Commit

Permalink
zulip_bots: Add doc.md for game_of_fifteen bot.
Browse files Browse the repository at this point in the history
Finishes #513.
  • Loading branch information
anehls93 authored and eeshangarg committed Jun 28, 2021
1 parent df60a1a commit 71d488e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions zulip_bots/zulip_bots/bots/game_of_fifteen/doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Game of Fifteen bot

This bot is designed to let you play a [game of fifteen](https://en.wikipedia.org/wiki/15_puzzle).

The goal of the game is to arrange all numbers from smallest to largest,
starting with the grey question mark in the upper left corner, and then
moving through each row till one reaches the end.

## Usage

To start a new game, simply type:

```
@game_of_fifteen
```

`move <tile1> <tile2>` - This command is used to pick which number to
switch with the grey question mark. Only pieces adjacent to the
grey question mark may be moved.

0 comments on commit 71d488e

Please sign in to comment.