完成部分配置文件内容

This commit is contained in:
lxbpxylps@126.com 2021-10-08 10:47:22 +08:00
parent f1381a5461
commit f572eeed2c
6 changed files with 120 additions and 2 deletions

View File

@ -3,3 +3,11 @@
* [功能介绍](feature) * [功能介绍](feature)
* [安装](install) * [安装](install)
* [配置文件](config)
* [.env](env)
* [group.json](group)
* [mc_server.json](mc_server)

3
config.md Normal file
View File

@ -0,0 +1,3 @@
# 配置文件
AkashicQQ 有许多配置文件。本部分将对各个配置文件的配置方法一一介绍。

47
config/env.md Normal file
View File

@ -0,0 +1,47 @@
# .env .env.dev .env.prod
.env .env.dev .env.prod 三个文件位于您的根目录中。
在配置其他配置文件之前,您应该首先配置三个配置文件。
## .env 文件
ENVIRONMENT=prod
+ `ENVIRONMENT`
`ENVIRONMENT` 项取值:
+ prod
+ dev
`ENVIRONMENT` 项决定了 AkashicQQ 运行在生产模式下还是调试模式下。
## .env.dev .env.prod 文件
这两个文件具有以下内容:
HOST=0.0.0.0
PORT=4399
DEBUG=true # .env.prod 文件中此项为 false
COMMAND_START=["#"]
+ `HOST` `PORT`
`HOST` 项是您的 AkashicQQ 绑定的 IP`PORT`项为绑定的端口。
如果您的 AkashicQQ、Prism Console、cqhttp(onebot) 协议实现程序都在同一服务器上运行,您可以将 `HOST` 项设置为 127.0.0.1。
> 注意:当 `HOST` 项设置为 0.0.0.0 时AkashicQQ 可能暴露在公网上,请通过配置防火墙的方式确保安全。
+ `DEBUG`
`DEBUG` 项无需更改。
+ `COMMAND_START`
`COMMAND_START` 项配置您的 QQ 命令起始符。例如,当 `COMMAND_START` 项包含 '#' 时,类似 #在线人数 的消息将被识别为一条命令。您可以配置多个命令起始符。
> 注意:不建议将命令起始符配置为 '/'。可能导致在 PC 端输入困难。
建议配置 .env.dev .env.prod 两个文件。这样可以通过更改 .env 中的 `ENVIRONMENT` 项快捷地在生产模式和调试模式中切换。

32
config/group.md Normal file
View File

@ -0,0 +1,32 @@
# group.json
> 注意group.json 及其之后的配置文件均为 JSON 格式,位于根目录下的 config 文件夹中。请使用 UTF-8 格式编辑和保存配置文件,并确保配置文件符合 JSON 格式。
{
"main_group": 123456789,
"op_user": [
654321,
123456
],
"admin_user": [
654321,
123456,
000123
]
}
+ `main_group`
`main_group` 项配置 QQ 群的群号。这应当是您的 Minecraft 服务器官方群的群号。请确认 AkashicQQ 使用的 QQ 号已加入此群并被设置为管理员。
+ `op_user`
`op_user` 项配置了哪些 QQ 号具有 OP 权限,即远程向任意服务器执行任意命令。
> 注意:请务必慎重配置此项。一般只建议将您自己配置为 `op_user`
+ `admin_user`
`admin_user` 项配置了哪些 QQ 号是您的管理员。管理员账号将会自动接收呼叫管理员等消息。请确认 AkashicQQ 使用的 QQ 号已和此配置项中的 QQ 号建立好友关系,否则将无法接收私聊消息。
> 注意:将 QQ 号配置为 `op_user` 并不会使其自动成为 `admin_user`。一般来说,您应当在两项中同时配置自己的 QQ 号。

28
config/mc_server.md Normal file
View File

@ -0,0 +1,28 @@
# mc_server.json
{
"main_server_tag": "主服",
"server": [
{
"tag": "主服",
"url": "http://127.0.0.1:8520"
},
{
"tag": "游戏服",
"url": "http://192.168.1.2:8520"
}
]
}
+ `main_server_tag`
`main_server_tag` 项应配置为您主要服务器的 tag。
> 注意:此处的 tag 即为您在 Prism Console 中的配置的 tag。请务必保持一致。
+ `server`
`server` 项为您每一个服务器的具体配置。
+ `tag`:服务器 Prism Console 的 tag
+ `url`:服务器 Prism Console API 对应的 url 地址,即 `http://{host}:{port}`

View File

@ -6,8 +6,8 @@
AkashicQQ 由以下几个模块构成,模块之间通过网络连接: AkashicQQ 由以下几个模块构成,模块之间通过网络连接:
+ AkashicQQ 机器人本体(一个 Python 程序) + [AkashicQQ 机器人本体](https://github.com/Mythologyli/AkashicQQ)(一个 Python 程序)
+ Prism Console一个 Python 程序) + [Prism Console](https://github.com/Mythologyli/Prism)(一个 Python 程序)
+ cqhttp(onebot) 协议实现程序,如 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)、[onebot-kotlin](https://github.com/yyuueexxiinngg/onebot-kotlin)、[OneBot-YaYa](https://github.com/Yiwen-Chan/OneBot-YaYa) 等等 + cqhttp(onebot) 协议实现程序,如 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)、[onebot-kotlin](https://github.com/yyuueexxiinngg/onebot-kotlin)、[OneBot-YaYa](https://github.com/Yiwen-Chan/OneBot-YaYa) 等等
可能有读者觉得模块太多,但正是这样的实现增强了 AkashicQQ 的可拓展性、可自定义性,提升了 AkashicQQ 的性能。你甚至可以将三个模块安装在三个服务器上,自由地分配服务器性能。 可能有读者觉得模块太多,但正是这样的实现增强了 AkashicQQ 的可拓展性、可自定义性,提升了 AkashicQQ 的性能。你甚至可以将三个模块安装在三个服务器上,自由地分配服务器性能。