Files
maimaiDX-API-Web-Server/README.md

83 lines
2.9 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.
# Maimai DX Web 工具
这是一个基于 Python (FastAPI) 和 Vue.js (Element Plus) 构建的 Web 工具,旨在提供一个用户友好的界面来管理和查看 maimai DX 模拟器的数据。
## 项目结构
```
maimai-web-app/
├── backend/ # Python 后端服务 (FastAPI)
└── frontend/ # Vue.js 前端应用 (Element Plus)
```
## 运行项目
请确保您的系统已安装 Python 3.8+ 和 Node.js (包含 npm)。
### 1\. 启动后端服务
打开您的命令行工具,进入 `maimai-web-app/backend` 目录,然后安装 Python 依赖并启动服务:
```bash
cd maimai-web-app/backend
pip install -r requirements.txt
python main.py
```
**注意:**
* 后端服务默认运行在 `http://0.0.0.0:8000`。如果您需要从其他设备访问(例如手机),请确保您的防火墙允许 8000 端口的传入连接,并且您的设备在同一局域网内,或者您已正确配置了端口映射。
* `main.py` 中的 `testUid8` 是一个默认的用户ID您可以在 `MyConfig.py` 中修改它。
### 2\. 启动前端应用
打开一个新的命令行工具(不要关闭后端服务的窗口),进入 `maimai-web-app/frontend` 目录,然后安装 Node.js 依赖并启动应用:
```bash
cd maimai-web-app/frontend
npm install
npm run dev -- --port 5174
```
前端应用默认运行在 `http://localhost:5174`。如果该端口被占用,它会自动尝试其他端口。您也可以通过 `--port` 参数指定端口,例如 `npm run dev -- --port 3000`
### 3\. 访问应用
在浏览器中打开前端应用提供的地址(通常是 `http://localhost:5174`)。
## 已实现功能
### 乐曲列表
* 浏览所有 maimai DX 乐曲。
* 支持按歌曲名和艺术家搜索。
### 用户中心
* **用户选择**: 通过输入用户ID获取玩家的完整信息或预览信息。
* **玩家操作**:
* **领取登录奖励**: 领取所有可用的每日登录奖励。
* **道具管理**: 解锁指定种类和ID的道具。
* **票券管理**: 购买指定类型的票券。
* **分数管理**: 上传或删除指定乐曲的分数记录。
* **上传至水鱼**: 将用户的分数上传至 [diving-fish.com](https://www.diving-fish.com/maimaidx/prober) 进行详细分析。
* **通用接口调用**: 通过输入API名称调用任意 `GetUser...Api` 接口,并显示原始响应。
* **危险操作**: 清空所有票券、强制用户登出。
* **分数详情**: 获取并显示用户的所有乐曲分数记录。
### 更新链接
* 获取 AuthLiteDelivery 更新链接列表。
* 解析每个更新链接指向的 INI 文件,并美观地展示其中的更新信息(如游戏描述、发布时间、主更新包和可选更新包链接)。
## 贡献
欢迎提交 Pull Request 或报告 Bug。在提交代码之前请确保您的代码符合项目规范。
## 许可证
本项目采用 MIT 许可证。详情请参阅 `LICENSE` 文件。