BOTKIT

This is the official repository for the XMTP bot kit and examples, powered by Turborepo.

To learn more about the contents of this repository, see this README and the READMEs provided for packages and examples.

What's inside?

Packages

• botkit: A kit for quickly building bots on the XMTP network
• create-xmtp-bot: A CLI for creating new XMTP bot projects
• playground: A visual playground for creating groups
• docs: Documentation for botkit

Templates

• subscription: A simple, customizable, and powerful conversational framework
• gpt: A bot that relays incoming messages to OpenAI's ChatGPT
• group: Group bot example.

See more examples in the Awesome XMTP ⭐️ repo

Run the example bots locally

Note
Before starting the bots locally, install the necessary dependencies by running yarn first. Update yarn with yarn set version stable

• yarn start:conversational: Start the conversational bot
• yarn start:gm: Start the GM bot
• yarn start:group: Start the Group bot

Contributing

See our contribution guide to learn more about contributing to this project.