搜索
切换搜索
切换菜单
切换个人菜单
欢迎来到小可 · Wiki,人人可编辑的,多平台聊天机器人“小可”的官方文档资源。
小可很可爱,请
给我们打钱
。
原 MkDocs 已迁入本站。若发现 404 属正常现象,请点击左上角搜索您想要的模块。
查看“自搭建指南”的源代码
来自小可 · Wiki,人人可编辑的,QQ机器人“小可”的官方文档资源
阅读
查看源代码
查看历史
页面
讨论
更多操作
←
自搭建指南
因为以下原因,您没有权限编辑本页:
您请求的操作仅限属于该用户组的用户执行:
用户
您可以查看和复制此页面的源代码。
本文将会指导你如何搭建与部署小可。 搭建机器人需要计算机等相关知识有一定的了解,若在阅读过程中感到困惑,请善于使用搜索引擎。 == 安装 Python 环境 == 请前往 [https://www.python.org/ Python 官网] 下载 Python 3.12 及以上版本,低于此版本将不再受到支持。 == 获取源代码 == === 使用 Git 克隆 === 请在需要放置小可的文件目录下打开终端,并输入以下命令: <syntaxhighlight lang="sh"> git clone https://github.com/Teahouse-studios/akari-bot.git </syntaxhighlight> === 直接下载 === 请前往[https://github.com/Teahouse-Studios/akari-bot/archive/refs/heads/master.zip 此处]下载 Master 分支的源代码。由于无法保证 Release 版本的稳定性,我们不再提供 Release 版本的下载。 {{Mbox | text = 不建议通过直接下载的方式进行部署,因为这样将无法使用 git 或 <code>~[[update]]</code> 命令更新机器人源代码。 | type = note }} == 安装依赖 == === 使用 Poetry === Poetry 是一个现代化的依赖管理工具,它能够帮助你管理项目的依赖和虚拟环境。要使用 Poetry 安装依赖,首先需请确保已经安装了 Poetry。 : '''Windows''' 打开终端或 PowerShell,执行以下命令: <syntaxhighlight lang="powershell"> (Invoke-WebRequest -Uri "https://install.python-poetry.org" -UseBasicParsing).Content | py - </syntaxhighlight> : '''Linux''' 打开终端并运行以下命令: <syntaxhighlight lang="sh"> curl -sSL https://install.python-poetry.org | python - </syntaxhighlight> 安装 Poetry 完成后,请执行以下命令安装依赖: <syntaxhighlight lang="sh"> poetry install </syntaxhighlight> === 使用 pip === pip 是 Python 自带的官方包管理工具。 如果你不想使用 Poetry,请执行以下命令安装依赖: <syntaxhighlight lang="sh"> pip install -r requirements.txt </syntaxhighlight> == 设置配置 == 进入 <code>config</code> 文件夹,将配置文件 <code>config.toml.example</code> 重命名为 <code>config.toml</code>,然后开始配置所需的内容。 {{Mbox | text = 当前配置文件使用 toml 格式。如果你使用的是旧版 cfg 文件,机器人会自动将其转换为 toml 格式。<br>在配置文件中填入必要的字段后,请删除所有未使用的字段,否则程序可能无法正常运行。 | type = important }} 在表 <code>secret</code> 储存的配置项为私有内容,例如 API 密钥等,当机器人发送的消息中存在这些内容时会被自动拦截。表 <code>config</code> 中大多数配置项的默认值与程序内设定一致。如果你觉得冗余,可以直接将其删除。 关于配置项的详细信息,请查看[[配置文件]]。 === 配置数据库 === 机器人需要一个数据库以用于存储用户数据。<code>db_path</code> 配置项需要填写一个可被 sqlalchemy 支持的数据库链接。 如果使用 MySQL 作为数据库: : 格式:<code>db_path = "mysql+pymysql://<数据库用户名>:<数据库用户密码>@<数据库地址>"</code> : 示例:<code>db_path = "mysql+pymysql://bot:123456@example.com/bot_prod"</code> 如果使用 SQLite 作为数据库: : 格式:<code>db_path = "sqlite:///<相对路径>/<数据库文件名>.db"</code> : 示例:<code>db_path = "sqlite:///database/save.db"</code> 此示例将会在 <code>database</code> 文件夹内创建 <code>save.db</code> 来存储用户数据。 {{Mbox | text = 如果你希望避免复杂的数据库安装或购买服务,建议使用 SQLite。注意,SQLite 可能会遇到极少数的锁表问题,或在误删文件未备份时数据丢失。 | type = note }} === 内容安全 === 机器人集成了[https://www.aliyun.com/product/lvwang 阿里云内容安全服务],用于检查 QQ 和 KOOK 平台下的消息安全。 如有需求,请前往阿里云进行开通并获取 AccessKeyID 及 AccessKeySecret,并在配置文件中填写相关配置项。 : <code>check_access_key_id =</code> - 填写获取的 AccessKeyID。 : <code>check_access_key_secret =</code> - 填写获取的 AccessKeySecret。 {{Mbox | text = 由于阿里云政策限制,内容安全服务'''不面向个人开发者''',必须完成阿里云企业认证才能使用。 | type = important }} === Webrender === Webrender 为机器人的外置服务,主要用于处理 Wiki infobox 图片渲染、 html 渲染以及部分功能的访问代理。 Webrender 的部署相关内容请见 [[Webrender#部署]]。亦可使用云服务产商的 Serverless 来部署本服务。 请在配置文件中 <code>web_render</code> 与 <code>web_render_local</code> 配置项填写访问地址。 : 格式: :: <code>web_render =</code> - Webrender 的地址(IP 或域名)及端口。 :: <code>web_render_local =</code> - 本地 Webrender 的地址,同时填写时将优先使用此地址。 : 示例:<code>web_render = "<nowiki>http://127.0.0.1:15551</nowiki>"</code> == 连接平台 == === QQ === 要在 QQ 平台连接机器人,请见[[自搭建/QQ]]。 === Discord === 要在 Discord 平台连接机器人,你需要建立好一个应用。 请前往并登录 [https://discord.com/developers Discord 开发者平台],点击“New application”,按照要求填写应用名字并确认创建。完成后,点击侧边导航栏“bot”,打开“Privileged Gateway Intents”目录下全部三个开关:<code>Presence Intent</code>、<code>Server Members Intent</code>、<code>Message Content Intent</code>。完成后点击“Save Changes”。 建立好应用后上滑,点击“Reset Token”,确认后点击“Copy”复制 Token。将复制的 Token 填写到配置文件的 <code>discord_token</code> 配置项中。 {{Mbox | text = 如果你的机器人所处的位置直接访问 Discord 有困难,请在配置文件的 <code>proxy</code> 配置项中填写代理服务地址。 | type = note }} 如果你想把机器人邀请到服务器中,需要在侧边栏“Installation”选项卡中的“Authorization Methods”选项中勾选 <code>Guild Install</code>。 要申请用于邀请机器人到 Discord 服务器的链接,请前往侧边导航栏“OAuth2”下方的子目录“URL Generator”,在“Scopes”中选择 <code>Bot</code> 后在下方“Bot Permissions”中选择你希望机器人拥有的权限。完成后复制下方生成的 URL,复制到浏览器打开。 {{Mbox | text = 如果给予的权限不充分,可能会导致无法发送消息或图片。<br>若你不确定具体应该添加哪些权限,可直接添加 Administrator(管理员)权限。 | type = important }} === Telegram === 要在 Telegram 平台连接机器人,你需要建立好一个机器人账户。 请在 Telegram 私信 [https://t.me/BotFather @BotFather],输入命令 <code>/start</code> 后使用 <code>/newbot</code> 按照要求创建一个机器人账号。 {{Mbox | text = <code>/newbot</code> 命令下需完成两个步骤: # 输入机器人的显示名称 # 输入机器人的账号名称(需以“bot”结尾) | type = important }} 完成后,@BotFather 会发送一条含有 Token 的消息。将复制的 Token 填写到配置文件的 <code>telegram_token</code> 配置项中。 {{Mbox | text = 如果你的机器人所处的位置直接访问 Telegram 有困难,请在配置文件的 <code>proxy</code> 配置项中填写代理服务地址。 | type = note }} === KOOK === 要在 KOOK(开黑啦)平台连接机器人,你需要建立好一个应用。 请前往并登录 [https://developer.kookapp.cn KOOK 开发者平台],点击“创建应用”,按照要求填写应用名字并确认创建。 完成后,点击侧边导航栏“机器人”,在“Token”下找到 Token 并复制。将复制的 Token 填写到配置文件的 <code>kook_token</code> 配置项中。 要申请用于邀请机器人到 KOOK 服务器的链接,请前往侧边导航栏“机器人”下方的子目录“邀请链接”,选择你希望机器人拥有的权限。完成后复制下方生成的 URL,复制到浏览器打开。 {{Mbox | text = 如果给予的权限不充分,可能会导致无法发送消息或图片。<br>若你不确定具体应该添加哪些权限,可直接添加<code>管理员</code>权限。 | type = important }} == 启动 == 根据系统不同,用以下方法即可启动机器人: : '''Windows''' 不推荐双击运行 <code>start.bat</code> 来启动机器人程序。 建议使用终端或 Powershell 运行: # 在机器人根目录下,按下 <kbd>Shift</kbd> + 右键来打开右键菜单。 # 选择“在此处打开 Powershell 窗口”或“在此处打开命令窗口”。 # 在终端内输入 <code>start.bat</code> 或在 Powershell 输入 <code>.\start.bat</code> 来启动机器人。 : '''Linux''' # 在终端内设置 <code>start</code> 脚本的执行权限:<code>chmod +x start</code> # 启动脚本:<code>./start</code> === 控制台 === [[控制台]]中包括了一个基础的运行环境,可以在控制台内使用命令进行基本的机器人交互。 运行控制台: # 在机器人根目录下打开终端。 # 在终端内使用 <code>poetry shell</code> 切换 Poetry 的虚拟环境来调用先前安装的依赖。(可选) # 在终端内运行 <code>python console.py</code> 以启动控制台。 [[Category:开发]]
本页使用的模板:
Template:Mbox
(
查看源代码
)
Template:Mbox/config
(
查看源代码
)
Template:Navbox dev
(
查看源代码
)
返回
自搭建指南
。
Cookie帮助我们提供我们的服务。通过使用我们的服务,您同意我们使用cookie。
更多信息
确定