python-zulip-api/zulip_bots/zulip_bots/bots/xkcd/doc.md

1.5 KiB

xkcd bot

xkcd bot is a Zulip bot that can fetch a comic strip from xkcd. To use the xkcd bot, you can simply call it with @xkcd followed by a command, like so:

@xkcd <command>

Run this bot as described in here.

Usage

The xkcd bot has four commands:

  1. help - This command is used to list all commands that can be used with this bot. Example usage: @xkcd help:

  2. latest - This command is used to fetch the latest comic strip from xkcd. Example usage: @xkcd latest:

  3. random- This command is used to fetch a random comic strip from xkcd. Example usage: @xkcd random:

  4. <comic_id> - To fetch a comic strip based on ID, you can supply the ID to the bot as a parameter (@xkcd <comic_id>). For example, if you want to fetch a comic strip with ID 1234, type @xkcd 1234: If the ID requested doesn't exist, the bot will post a message that the comic strip associated with that ID is not available, like so:

  5. If you type a command that isn't recognized by the bot, it will respond the information printed by the @xkcd help command: