xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

interactive bots: Improve documentation for tictactoe bot.

Browse source
This commit is contained in:
Jerry Zhang 2017-12-12 16:59:20 -08:00 committed by showell
parent 878691a745
commit ce8979df7a
1 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
zulip_bots/zulip_bots/bots/tictactoe/doc.md
View file

@ -1,4 +1,4 @@
# About Tic-Tac-Toe Bot # Tic-Tac-Toe Bot
This bot allows you to play tic-tac-toe in a private message with the bot. This bot allows you to play tic-tac-toe in a private message with the bot.
Multiple games can simultaneously be played by different users, each playing Multiple games can simultaneously be played by different users, each playing
@ -6,18 +6,21 @@ against the computer.
The bot only responds to messages starting with @mention of the bot(botname). The bot only responds to messages starting with @mention of the bot(botname).
### Commands ## Setup
**@mention-botname new** will start a new game (but not if you are This bot does not require any special setup. Just run it according to the
already playing a game.) You must type this first to start playing! instructions in [this guide](https://zulipchat.com/api/running-bots#running-a-bot).
**@mention-botname help** will return a help function with valid ## Commands
commands and coordinates. * `@mention-botname new` - start a new game (but not if you are already
playing a game.) You must type this first to start playing!
**@mention-botname quit** will quit from the current game. * `@mention-botname help` - return a help message.
**@mention-botname <coordinate>** will make a move at the * `@mention-botname quit` - quit the current game.
entered coordinate. For example, **@mention-botname 1,1** . After this, the bot will make
its move, or declare the game over if the user or bot has won. * `@mention-botname <coordinate>` - make a move at the entered coordinate.
For example, `@mention-botname 1,1` . After this, the bot will make its
move, or declare the game over if the user or bot has won.
Coordinates are entered in a (row, column) format. Numbering is from top to Coordinates are entered in a (row, column) format. Numbering is from top to
bottom and left to right. bottom and left to right.
@ -31,4 +34,4 @@ and spaces are optional.
(3, 1) | (3, 2) | (3, 3) (3, 1) | (3, 2) | (3, 3)
Invalid commands will result in an "I don't understand" response from the bot, Invalid commands will result in an "I don't understand" response from the bot,
with a suggestion to type **@mention-botname help** . with a suggestion to type `@mention-botname help`.