MihoyoBBSTools 项目使用教程

1. 项目的目录结构及介绍

MihoyoBBSTools 项目的目录结构如下：

MihoyoBBSTools/
├── mihoyobbs.py
├── ql_main.py
├── request.py
├── requirements.txt
├── server.py
├── setting.py
├── start.bash
├── tools.py
├── config/
│   ├── config.yaml.example
│   └── ...
└── README.md

目录结构介绍

• mihoyobbs.py: 主程序文件，负责主要的逻辑处理。
• ql_main.py: 可能是与签到相关的辅助文件。
• request.py: 处理网络请求的模块。
• requirements.txt: 项目依赖的 Python 包列表。
• server.py: 可能是用于启动服务器的文件。
• setting.py: 配置相关的模块。
• start.bash: 启动脚本的 Bash 文件。
• tools.py: 工具模块，包含一些辅助函数。
• config/: 配置文件目录，包含示例配置文件 config.yaml.example。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

启动文件

• start.bash: 这是一个 Bash 脚本，用于启动项目。使用方法如下：

chmod +x start.bash
./start.bash

启动流程

1. 赋予 start.bash 执行权限。
2. 运行 start.bash 脚本启动项目。

3. 项目的配置文件介绍

配置文件

• config/config.yaml: 项目的配置文件，包含各种配置选项。

配置文件示例

account:
  cookie: "your_cookie_here"
  # 其他配置项...

配置文件说明

• account: 账户相关配置。
  • cookie: 米游社的 Cookie，用于登录和验证。

配置文件的使用

1. 复制 config/config.yaml.example 为 config/config.yaml。
2. 使用文本编辑器（如 VSCode 或 Vim）打开 config/config.yaml。
3. 根据需要修改配置项，特别是 cookie 项，填入从米游社获取的 Cookie。

通过以上步骤，您可以成功配置并启动 MihoyoBBSTools 项目。