From 999a77c348af25a4c548ea8cf4abb25bd1ffe6da Mon Sep 17 00:00:00 2001 From: Richard Chien Date: Wed, 15 Aug 2018 01:24:25 +0800 Subject: [PATCH] Update skeleton --- docs/.vuepress/config.js | 5 +++++ docs/guide/basic-configurations.md | 3 +++ docs/guide/getting-started.md | 10 +++++++++- docs/guide/group-management.md | 3 +++ docs/guide/installation.md | 2 +- docs/guide/tuling.md | 3 +++ docs/guide/whats-happened.md | 2 +- docs/guide/write-commands.md | 3 +++ docs/guide/write-nl-processors.md | 5 +++++ 9 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 docs/guide/basic-configurations.md create mode 100644 docs/guide/group-management.md create mode 100644 docs/guide/tuling.md create mode 100644 docs/guide/write-commands.md create mode 100644 docs/guide/write-nl-processors.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 39006a68..e9fdfb5c 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -26,6 +26,11 @@ module.exports = { 'installation', 'getting-started', 'whats-happened', + 'basic-configurations', + 'write-commands', + 'write-nl-processors', + 'tuling', + 'group-management', ] } ] diff --git a/docs/guide/basic-configurations.md b/docs/guide/basic-configurations.md new file mode 100644 index 00000000..0cfca069 --- /dev/null +++ b/docs/guide/basic-configurations.md @@ -0,0 +1,3 @@ +# 基本配置 + +本章将介绍 NoneBot 的一些基本配置。 diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index c81855ea..5e0310e0 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -23,6 +23,10 @@ if __name__ == '__main__': 2. 加载 NoneBot 内置的插件 3. 在地址 `127.0.0.1:8080` 运行 NoneBot +::: tip 提示 +这里 `none.run()` 的参数 `host='127.0.0.1'` 表示让 NoneBot 监听本地回环地址，如果你的酷 Q 运行在非本机的其它位置，例如 Docker 容器内、局域网内的另一台机器上等，则这里需要修改 `host` 参数为希望让 CoolQ HTTP API 插件访问的 IP。如果不清楚该使用哪个 IP，或者希望本机的所有 IP 都被监听，可以使用 `0.0.0.0`。 +::: + 在命令行使用如下命令即可运行这个 NoneBot 实例： ```bash @@ -44,7 +48,9 @@ python bot.py } ``` -注意，这里的 `127.0.0.1:8080` 即对应 `none.run()` 中传入的 `host` 和 `port`，如果在 `none.run()` 中传入的 `host` 是 `0.0.0.0`，则插件的配置中需使用任意一个能够访问到 NoneBot 所在环境的 IP。特别地，如果你的酷 Q 运行在 Docker 容器中，NoneBot 运行在宿主机中，则默认情况下这里需使用 `172.17.0.1`（不同机器有可能不同，需使用 `docker inspect bridge` 查看，具体见 Docker 文档的 [Configure networking](https://docs.docker.com/network/)）。 +::: tip 提示 +这里的 `127.0.0.1:8080` 对应 `none.run()` 中传入的 `host` 和 `port`，如果在 `none.run()` 中传入的 `host` 是 `0.0.0.0`，则插件的配置中需使用任意一个能够访问到 NoneBot 所在环境的 IP。特别地，如果你的酷 Q 运行在 Docker 容器中，NoneBot 运行在宿主机中，则默认情况下这里需使用 `172.17.0.1`（不同机器有可能不同，需使用 `docker inspect bridge` 查看，具体见 Docker 文档的 [Configure networking](https://docs.docker.com/network/)）。 +::: 修改之后，在酷 Q 的应用菜单中重启 CoolQ HTTP API 插件，或直接重启酷 Q，以使新的配置文件生效。 @@ -59,7 +65,9 @@ python bot.py 这表示 CoolQ HTTP API 插件已经成功地连接上了 NoneBot，与此同时，插件的日志文件中也会输出反向 WebSocket 连接成功的日志。 +::: warning 注意 如果到这一步你没有看到上面这样的日志，请注意排查配置中的 IP 和端口是否确实可以访问。 +::: 现在，尝试向你的 QQ 机器人账号发送如下内容： diff --git a/docs/guide/group-management.md b/docs/guide/group-management.md new file mode 100644 index 00000000..e6d010db --- /dev/null +++ b/docs/guide/group-management.md @@ -0,0 +1,3 @@ +# 实现群管功能 + +本章将教你如何使用 NoneBot 实现自动同意或拒绝入群请求、欢迎新成员、踢出不良成员等功能。 diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 9bccca53..9e3ccf05 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -26,7 +26,7 @@ python setup.py install 前往酷 Q 官方论坛的 [版本发布](https://cqp.cc/b/news) 页面根据需要下载最新版本的酷 Q Air 或 Pro，解压后启动 `CQA.exe` 或 `CQP.exe` 并登录 QQ 机器人账号。 -如果你的操作系统是 Linux 或 macOS，可以使用版本发布页中酷 Q 官方提供的 Docker 镜像，也可以直接跳至下一个标题，使用 CoolQ HTTP API 插件官方提供的 Docker 镜像。 +如果你的操作系统是 Linux 或 macOS，可以使用版本发布页中酷 Q 官方提供的 Docker 镜像，也可以直接跳至下一节，使用 CoolQ HTTP API 插件官方提供的 Docker 镜像。 ::: tip 提示 如果这是你第一次使用酷 Q，建议完成它自带的新手教程，从而对酷 Q 的运行机制有所了解。 diff --git a/docs/guide/tuling.md b/docs/guide/tuling.md new file mode 100644 index 00000000..1aaf7166 --- /dev/null +++ b/docs/guide/tuling.md @@ -0,0 +1,3 @@ +# 接入图灵机器人 + +本章将教你如何接入图灵机器人的 API，使你的 QQ 机器人能够回复任意消息。 diff --git a/docs/guide/whats-happened.md b/docs/guide/whats-happened.md index 5bb62ad5..024fad75 100644 --- a/docs/guide/whats-happened.md +++ b/docs/guide/whats-happened.md @@ -1,3 +1,3 @@ # 发生了什么？ -本节将带你理解上一节中的 NoneBot 最小实例是如何对你发送的消息做出反应的。 +本章将带你理解上一章中的 NoneBot 最小实例是如何对你发送的消息做出反应的。 diff --git a/docs/guide/write-commands.md b/docs/guide/write-commands.md new file mode 100644 index 00000000..08add077 --- /dev/null +++ b/docs/guide/write-commands.md @@ -0,0 +1,3 @@ +# 编写命令 + +本章将以天气查询功能为例，教你如何编写自己的命令。 diff --git a/docs/guide/write-nl-processors.md b/docs/guide/write-nl-processors.md new file mode 100644 index 00000000..a5223af8 --- /dev/null +++ b/docs/guide/write-nl-processors.md @@ -0,0 +1,5 @@ +# 编写自然语言处理器 + +本章将教你如何编写自己的自然语言处理器，使上一章的天气查询功能不再局限于固定格式的命令，而是能够处理自然的句子。 + +除此之外，还会教你如何单独使用自然语言处理器，而不必编写与之配套的命令。