diff --git a/README.md b/README.md index 1ae9569b096389937ca658cdf20de4e5a712d430..3015ce53a62d61bbfc89955b696107466a30ed59 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,143 @@ - - -### 一、源自: -**** - 本程序参考:https://gitee.com/lzylkylkx/stzbHelper 做的java版本翻译,仅供学习使用。 -### 二、功能: -**** - 1.首页,个人主薄信息 + 翻译代码辛苦赞赏点勤劳费 - 同盟成员信息 - 同盟各分组武勋排名 - 攻城战报/士地战报 白城考勤必备, - 开荒本盟上榜名单 24,48小时开荒使用 - 宝物价格分析 本地淘宝更舒服。 - 同盟战报分析-NPC对战 对战npc防摸鱼 - 同盟战报分析[首战士地] 看队伍帮您开荒。 - 同盟战报[玩家] 看队伍信息,帮你更好配置自己队伍。 -### 三、演示: -1、考勤辅助: -https://www.bilibili.com/video/BV1SHQvB1EUL/?spm_id_from=333.1387.homepage.video_card.click -2、个人队伍参考: -https://www.bilibili.com/video/BV1zqdZBBE9s/?spm_id_from=333.1387.homepage.video_card.click - -### 四、其他说明: -本程序仅限个人学习使用,娱乐游戏,开心生活,不要违法犯罪,如有法律等问题,请及时联系本人!!!! - -### 五、联系方式 - qq群:414517163 - - - - + + +# Nice Roll + +## 一、项目简介 + +本项目是一款基于 Spring Boot 开发的三国志战略版游戏辅助工具,通过网络数据包捕获与分析,为玩家提供游戏数据查询、战报分析、同盟成员管理等功能。 + +> **声明**:本程序仅供个人学习使用,娱乐游戏,开心生活,不要违法犯罪。 + +## 二、功能特性 + +### 2.1 核心功能 + +| 功能模块 | 说明 | +|---------|------| +| **个人主页** | 玩家主簿信息查询 | +| **同盟管理** | 同盟成员信息、同盟各分组武勋排名 | +| **战报分析** | 攻城战报、土地战报、首发战士地、玩家对战战报 | +| **考勤辅助** | 白城考勤必备功能 | +| **开荒榜单** | 24/48小时开荒上榜名单 | +| **宝物分析** | 宝物价格分析,本地淘宝更舒适 | +| **NPC对战** | 同盟战报分析 - NPC对战防摸鱼 | + +### 2.2 技术架构 + +- **后端框架**:Spring Boot + OpenFeign +- **网络捕获**:Pcap4J (libpcap) +- **数据推送**:企业微信机器人 +- **数据存储**:内存缓存 (Map 结构) +- **前端**:HTML + CSS + JavaScript (Thymeleaf 模板) + +### 2.3 主要组件 + +``` +├── com.nice.core # 核心配置 (CORS、Web资源) +├── com.nice.db # 数据缓存层 +│ ├── base # 基础数据映射 (武将、技能、宝物、战法) +│ ├── util # 数据获取工具 +│ └── *Cache # 各类缓存 (战报、排名、宝物等) +├── com.nice.feign # 远程调用 (企业微信、Tomorrow518) +├── com.nice.game # 游戏核心逻辑 +│ ├── service # 业务服务 (数据包解析、消息处理、推送) +│ ├── util # 工具类 (解压、线程池、时间处理) +│ ├── vo # 值对象 +│ └── web # Web控制器 +└── com.nice.page # 页面控制器与前端数据模型 +``` + +## 三、快速开始 + +### 3.1 环境要求 + +- JDK 1.8+ +- Maven 3.6+ +- libpcap (Linux) / WinPcap (Windows) - 用于网络数据包捕获 + +### 3.2 构建与运行 + +```bash +# 打包项目 +mvn clean package -DskipTests + +# 运行项目 +java -jar target/nice-roll.jar +``` + +### 3.3 配置说明 + +在 `src/main/resources/application.yml` 中配置: + +- 游戏服务器连接信息 +- 企业微信机器人密钥 +- 网络接口卡选择 +- 数据推送策略 + +### 3.4 访问地址 + +启动后访问:`http://localhost:8080` + +## 四、接口 API + +### 4.1 游戏数据 + +| 接口 | 说明 | +|-----|------| +| `GET /game/player` | 获取当前玩家信息 | +| `GET /game/cityRank` | 城市排行榜 | +| `GET /game/teamUser` | 同盟成员列表 | +| `GET /game/teamUser/groupWu` | 同盟分组武勋排名 | + +### 4.2 战报数据 + +| 接口 | 说明 | +|-----|------| +| `GET /game/battleReport` | 战报列表 | +| `GET /game/battleReport/info` | 战报详情 | +| `GET /game/battleReport/other` | 土地战报 | +| `GET /game/battleReport/first` | 首发战报 | +| `GET /game/battleReport/ai` | AI战报 | + +### 4.3 宝物数据 + +| 接口 | 说明 | +|-----|------| +| `GET /game/baowu` | 宝物列表 | +| `GET /game/baowu/tab` | 宝物分类 | + +### 4.4 考勤与榜单 + +| 接口 | 说明 | +|-----|------| +| `GET /game/renzhen` | 考勤认证 | +| `GET /game/24hLeaderboard` | 24小时开荒榜 | +| `GET /game/24hLeaderboard/photo` | 榜上玩家数据 | + +### 4.5 缓存管理 + +| 接口 | 说明 | +|-----|------| +| `GET /cache/clear/battleReport` | 清除战报缓存 | +| `GET /cache/clear/clearTeamUser` | 清除成员缓存 | + +## 五、演示视频 + +1. **考勤辅助**:https://www.bilibili.com/video/BV1SHQvB1EUL/ +2. **个人队伍参考**:https://www.bilibili.com/video/BV1zqdZBBE9s/ + +## 六、相关项目 + +本程序参考 [stzbHelper](https://gitee.com/lzylkylkx/stzbHelper) Java 版本翻译,仅供学习使用。 + +## 七、许可证 + +本项目仅供个人学习使用,禁止任何商业用途。 + +## 八、联系方式 + +- QQ 群:414517163 + +--- + +**温馨提示**:请合理使用辅助工具,享受游戏带来的乐趣! \ No newline at end of file