快速上手 ​

安装 ​

使用 Python 软件包安装程序 (pip) 进行安装：

pip install iamai

从 GitHub 中安装最新的开发版：

git clone https://github.com/retrofor/iamai.git
cd iamai
pdm install

安装适配器 ​

iamai 本身只是一个聊天机器人框架，需要额外安装对应协议的适配器来支持特定的协议，你可以使用 pip 安装协议适配器：

pip install iamai-adapter-cqhttp
pip install iamai-adapter-onebot
pip install iamai-adapter-mirai
pip install iamai-adapter-dingtalk

或者你也可以在安装 iamai 的同时搭配对应的适配器，如：

pip install iamai[all]
pip install iamai[cqhttp]
pip install iamai[onebot]
pip install iamai[mirai]
pip install iamai[dingtalk]

第一个项目 ​

本文会帮助你从零开始搭建一个简单的 iamai 机器人项目。

1. 创建并进入一个新目录

   sh

   mkdir iamai-starter && cd iamai-starter

2. 创建一个 main.py 文件并写入以下内容

   python

   from iamai import Bot
   
   bot = Bot()
   
   if __name__ == "__main__":
       bot.run()

3. 创建一个 config.toml 文件并写入以下内容

   toml

   [bot]
   plugin_dirs = ["plugins"]
   adapters = ["iamai.adapter.cqhttp"]

4. 创建一个 plugins 目录

   sh

   mkdir plugins

5. 试试运行 main.py 吧！

   sh

   python main.py

你应该会看到以下输出的日志

2021-07-24 00:00:00.000 | INFO     | iamai.bot:_load_plugins_from_dirs:689 - Loading plugins from dirs "/xxx/plugins"
2021-07-24 00:00:00.000 | INFO     | iamai.bot:_load_adapters:746 - Succeeded to load adapter "CQHTTPAdapter" from "iamai.adapter.cqhttp"
2021-07-24 00:00:00.000 | INFO     | iamai:run:90 - Running iamai...

目录结构 ​

iamai 推荐的目录结构如下：

.
├── plugins (插件目录)
│   └── xxx.py
├── config.toml (配置文件)
└── main.py

其中 main.py 和 config.toml 文件如上文所示。

配置协议端 ​

上面的例子中使用了 iamai.adapter.cqhttp 协议适配器，它是 OneBot v11 协议 (原 CKYU 平台的 CQHTTP 协议) 的适配器，需要一个兼容 OneBot 协议的协议端进行通讯，以下是一些常用的支持 OneBot 协议的 QQ 协议端：

• go-cqhttp
• mirai + onebot-kotlin
• oicq

更多信息详见 CQHTTP 协议使用指南。

你也可以安装其他协议适配器或者尝试自己写一个协议适配器。

开发建议 ​

在使用 iamai 进行开发时，建议使用具有类型检查的 IDE，如 PyCharm、VSCode 等，这可以帮助你充分利用 iamai 的类型提示。