OpenShamrock/docs/guide/configuration.md
2023-10-28 11:41:51 +08:00

70 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: 应用配置
icon: cog
---
::: tip 提示
Shamrock 提供了一个图形化的配置界面,可进行简单的配置操作。
大部分配置简单易于理解,我们仅仅介绍部分难于理解的配置选项。
:::
## 配置选项
### 强制平板模式
<!-- 这句话我不是很理解,不知道是不是这个意思 -->
强制要 QQ 客户端 以平板模式运行,让机器人于主账号登录在手机共存登录。
### 专业级接口
提供一些危险的接口,如 签名/发包 一系列不合规的操作。
::: warning 注意
使用这些接口可能会导致 QQ 账号 被封禁,若非必要,请不要使用。
:::
::: tip 提示
除了 WebSocket 相关功能其他功能的配置进行修改立即生效无需重新启动QQ。
不建议使用 CQ 码,因为在新一代机器人设计理念中,该操作过于落后,可能会出现许多问题。
:::
::: warning 注意
被动 WebSocket 在断线之后,每隔 5 秒尝试重新连接。
:::
## 目录定义
- 内部存储目录: `/storage/emulated/0` # 或 `/sdcard`
- QQ 主目录: `内部存储目录 + /Android/data/com.tencent.mobileqq`
- Shamrock 主目录: `QQ主目录 + /Tencent/Shamrock`
## 事件过滤
当前仅支持,群聊 |私聊 黑/白名单。
将下方 JSON 文件创建在 `Shamrock 主目录 + /config.json`
请确保 JSON 格式正确。
```json
{
"group_rule": {
"black_list": [...],
"white_list": [...]
}
}
```
## 数据目录
大部分 Shamrock 的数据/缓存保存在 `Shamrock 主目录`
其中的日志可作为 Issue 内容,截取部分提交。
```bash
.
├── tmpfiles # 临时文件目录
│ ├── logs # 日志目录
│ │ └── xxx.log # 日志文件
├── config.json # 配置文件
```