koishi-plugin-ggcevo-game 1.1.3 → 1.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/lib/index.js +32 -14
  2. package/package.json +2 -2
  3. package/readme.md +93 -1
package/lib/index.js CHANGED
@@ -29,20 +29,38 @@ module.exports = __toCommonJS(src_exports);
29
29
  var import_koishi = require("koishi");
30
30
  var import_koishi_plugin_sc2arcade_search = require("koishi-plugin-sc2arcade-search");
31
31
  var name = "ggcevo-game";
32
- var Config = import_koishi.Schema.object({
33
- proxyAgent: import_koishi.Schema.string().description("代理服务器地址"),
34
- ggcqun: import_koishi.Schema.string().description("开启咕咕虫排行榜的群组").required(),
35
- rankseason: import_koishi.Schema.string().description("当前赛季").required(),
36
- signrequire: import_koishi.Schema.boolean().description("是否开启签到要求进行一场游戏").default(true),
37
- autorank: import_koishi.Schema.boolean().description("是否开启每小时自动同步rank数据").default(true),
38
- ignoreGlobalLimit: import_koishi.Schema.boolean().description("是否开启无限制兑换").default(false),
39
- admins: import_koishi.Schema.array(import_koishi.Schema.string()).description("管理员QQ号列表,支持配置多个").default([]).role("table"),
40
- groupId: import_koishi.Schema.array(import_koishi.Schema.string()).description("游戏大厅黑名单通知群组,例如 onebot:123456").default([]).role("table"),
41
- checkInterval: import_koishi.Schema.number().default(60).description("检查间隔(秒)"),
42
- dailyPKLimit: import_koishi.Schema.number().description("每人每天可发起PK次数").default(3),
43
- sameOpponentLimit: import_koishi.Schema.boolean().description("是否开启同玩家每日单次PK限制").default(true),
44
- maxDailyBeChallenged: import_koishi.Schema.number().description("每日最多被挑战次数(0=无限制)").default(5)
45
- });
32
+ var Config = import_koishi.Schema.intersect([
33
+ // 基础配置组
34
+ import_koishi.Schema.object({
35
+ proxyAgent: import_koishi.Schema.string().description("代理服务器地址"),
36
+ ggcqun: import_koishi.Schema.string().description("绑定咕咕虫evo的群组ID").required()
37
+ }).description("基础设置"),
38
+ // 赛季与兑换配置组
39
+ import_koishi.Schema.object({
40
+ rankseason: import_koishi.Schema.string().description("当前赛季名称(影响兑换系统)").required(),
41
+ ignoreGlobalLimit: import_koishi.Schema.boolean().description("禁用全局兑换限制(谨慎开启)").default(false)
42
+ }).description("赛季配置"),
43
+ // 核心功能开关组
44
+ import_koishi.Schema.object({
45
+ signrequire: import_koishi.Schema.boolean().description("游戏对局签到要求").default(true),
46
+ autorank: import_koishi.Schema.boolean().description("自动同步天梯数据").default(true)
47
+ }).description("功能开关"),
48
+ // 对战系统配置组
49
+ import_koishi.Schema.object({
50
+ dailyPKLimit: import_koishi.Schema.number().description("每日最大发起PK次数").default(3),
51
+ sameOpponentLimit: import_koishi.Schema.boolean().description("同玩家每日单次限制").default(true),
52
+ maxDailyBeChallenged: import_koishi.Schema.number().description("最大被挑战次数(0=无限制)").default(5)
53
+ }).description("对战限制"),
54
+ // 通知系统配置组
55
+ import_koishi.Schema.object({
56
+ groupId: import_koishi.Schema.array(import_koishi.Schema.string()).description("黑名单通知群组").default([]),
57
+ checkInterval: import_koishi.Schema.number().description("大厅监控检查间隔(秒)").default(60)
58
+ }).description("通知设置").collapse(),
59
+ // 权限管理组
60
+ import_koishi.Schema.object({
61
+ admins: import_koishi.Schema.array(import_koishi.Schema.string()).description("管理员QQ列表").default([])
62
+ }).description("权限管理")
63
+ ]);
46
64
  var inject = {
47
65
  required: ["database"]
48
66
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "koishi-plugin-ggcevo-game",
3
- "description": "星际争霸2游戏大厅咕咕虫-Evo地图专属插件。",
4
- "version": "1.1.3",
3
+ "description": "《星际争霸2》咕咕虫-evolved地图的专属游戏助手插件,集成天梯排行、抽奖系统、签到福利、兑换商城等丰富功能。",
4
+ "version": "1.1.4",
5
5
  "main": "lib/index.js",
6
6
  "typings": "lib/index.d.ts",
7
7
  "files": [
package/readme.md CHANGED
@@ -2,4 +2,96 @@
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/koishi-plugin-ggcevo-game?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-ggcevo-game)
4
4
 
5
- 星际争霸2游戏大厅咕咕虫-Evo地图专属插件。
5
+ 《星际争霸2》咕咕虫-evolved地图的专属游戏助手插件,集成天梯排行、抽奖系统、签到福利、兑换商城等丰富功能。
6
+
7
+ ## 功能清单
8
+
9
+ ### 核心系统
10
+ - 🎰 **保底抽奖系统**:支持单抽/十连抽,隐藏奖励机制
11
+ - 📅 **智能签到系统**:结合游戏对局验证的签到机制
12
+ - 🏆 **天梯排名系统**:自动同步胜点数据,动态排行榜
13
+ - 🛍️ **兑换商城系统**:多层级奖品池,赛季限定物品
14
+
15
+ ### 特色功能
16
+ - ⚔️ **玩家对战系统**:金币PK玩法,动态胜率计算
17
+ - 🚨 **违规监控系统**:大厅玩家行为监控,黑名单管理
18
+ - 🎁 **活动管理系统**:福利活动创建与发放
19
+ - 📊 **数据统计系统**:玩家成就、背包、抽奖记录等全维度统计
20
+
21
+ ## 安装配置
22
+
23
+ 1. 安装插件
24
+ ```bash
25
+ npm install koishi-plugin-ggcevo-game
26
+ ```
27
+
28
+ 2. 基础配置 (koishi.yml)
29
+ ```yaml
30
+ plugins:
31
+ ggcevo-game:
32
+ proxyAgent: '' # 代理地址(如需)
33
+ ggcqun: '你的群号' # 绑定游戏群组
34
+ rankseason: 'S1' # 当前赛季名称
35
+ signrequire: true # 对局签到要求
36
+ autorank: true # 自动同步天梯数据
37
+ dailyPKLimit: 3 # 每日最大PK次数
38
+ admins: [管理员QQ列表] # 管理员权限
39
+ ```
40
+
41
+ ## 使用说明
42
+
43
+ ### 玩家命令
44
+ ```bash
45
+ 每日签到
46
+ /签到
47
+
48
+ 抽奖系统
49
+ /单抽
50
+ /十连抽
51
+ /抽奖记录
52
+
53
+ 天梯系统
54
+ /胜点榜
55
+ /排名 @玩家
56
+
57
+ 对战系统
58
+ /pk @玩家
59
+ /切换pk状态
60
+
61
+ 兑换系统
62
+ /兑换
63
+ /兑换扭蛋币
64
+ ```
65
+
66
+ ### 管理命令
67
+ ```bash
68
+ 活动管理
69
+ /创建活动 <名称> <描述> <奖励数量>
70
+
71
+ 玩家管理
72
+ /活动拉黑
73
+ /胜点榜拉黑
74
+
75
+ 数据维护
76
+ /胜点榜数据同步
77
+ ```
78
+
79
+ ## 数据模型
80
+ ```
81
+ 📦 数据库结构
82
+ ├── 用户背包 (ggcevo_backpack)
83
+ ├── 签到记录 (ggcevo_sign)
84
+ ├── 天梯数据 (ggcevo_rank)
85
+ ├── 对战记录 (ggcevo_pk_logs)
86
+ ├── 兑换记录 (ggcevo_exchange)
87
+ └── 活动管理 (ggcevo_activity)
88
+ ```
89
+
90
+ ## 注意事项
91
+
92
+ 1. **敏感词检测**:需要配置第三方API(示例使用 api.iminbk.com)
93
+ 2. **定时任务**:自动天梯同步默认每小时执行,请根据需求调整频率
94
+ 3. **赛季设置**:兑换系统依赖 `rankseason` 配置项,赛季变更时需更新
95
+ 4. **代理配置**:国内服务器建议配置代理访问SC2Arcade API
96
+
97
+ > 提示:使用前请确保已安装 [koishi-plugin-sc2arcade-search](https://www.npmjs.com/package/koishi-plugin-sc2arcade-search) 作为前置插件