yz-yuki-plugin 2.0.3-2 → 2.0.3-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.
package/README.md CHANGED
@@ -8,20 +8,34 @@
8
8
 
9
9
  [![访问量](https://profile-counter.glitch.me/yuki-plugin/count.svg)](https://github.com/snowtafir/yuki-plugin)
10
10
 
11
- ## 🌰安装插件
11
+ # 🌰一、安装插件
12
12
 
13
- #### 1. 安装方式选择
14
- 按照网络情况或个人喜好,选择安装方式。
13
+ ## 选择安装方式
14
+ 按照网络情况以及使用的bot框架是`Yunzai-Next`还是`Yunzai-V3:`,选择对应的安装方式。
15
15
 
16
- ##### ```Yunzai-Next:```
16
+ ### ***(一)Yunzai-Next***
17
+ > 选择其中一种方式安装插件:
17
18
 
18
- 1. 方式1: yunzai-next npm包 安装插件:
19
- >```
20
- > yarn add yz-yuki-plugin -W
21
- >```
22
- 接着修改 `yunzaijs/yunzai.config.js`,按版本选择修改方式:
19
+ 1. npm包安装到`yunzai-next/node_modules`的方式,仅Yunzai-Next支持:
20
+ ```
21
+ yarn add yz-yuki-plugin -W
22
+ ```
23
+
24
+ 选择启用插件方式:
23
25
 
24
- Yunzai-Next v4.1.33+及以上版本:
26
+ * 方式1(推荐):
27
+
28
+ 手动新建 `yunzai-next/yunzai.config.json` 文件,输入如下内容,`applications`字段添加的 `"yz-yuki-plugin"`即为启用本插件:
29
+
30
+ ```json
31
+ {
32
+ "applications": ["yz-system", "yz-yuki-plugin"],
33
+ "middlewares": ["yunzai-mys/runtime", "yunzai-mys/mw"]
34
+ }
35
+ ```
36
+ * 方式2:
37
+
38
+ 修改 `yunzai-next/yunzai.config.js`:
25
39
  ```js
26
40
  import { defineConfig } from 'yunzai'
27
41
  export default defineConfig({
@@ -30,69 +44,64 @@ export default defineConfig({
30
44
  })
31
45
  ```
32
46
 
33
- 旧版本:
34
- ```js
35
- import yuki from 'yz-yuki-plugin' //新增该行
36
- export default defineConfig({
37
- applications: [system(), yuki()], //该行添加 yuki()
38
- middlewares: [runtime(), starRail()]
39
- })
40
- ```
47
+ 2. 安装到 `yunzai-next/plugins` 的方式:
41
48
 
42
- 2. 方式2(V3的方式):
43
- >gitee仓库:
44
- >```
45
- >git clone --branch main https://gitee.com/snowtafir/yuki-plugin.git ./plugins/yuki-plugin
46
- >```
49
+ > 仅支持Yunzai-Next的分支,选择仓库:
47
50
 
48
- >github仓库:
49
- >```
50
- >git clone --branch main https://github.com/snowtafir/yuki-plugin.git ./plugins/yuki-plugin
51
- >```
51
+ gitee仓库:
52
+ ```shell
53
+ git clone --branch main https://gitee.com/snowtafir/yuki-plugin.git ./plugins/yuki-plugin
54
+ ```
55
+
56
+ github仓库:
57
+ ```shell
58
+ git clone --branch main https://github.com/snowtafir/yuki-plugin.git ./plugins/yuki-plugin
59
+ ```
52
60
 
53
- ##### ```Yunzai-V3:```
54
- >gitee仓库:
55
- >```
56
- >git clone --branch main3 https://gitee.com/snowtafir/yuki-plugin.git ./plugins/yuki-plugin
57
- >```
61
+ * 依赖安装:
62
+ ```shell
63
+ yarn install
64
+ ```
58
65
 
59
- >github仓库:
60
- >```
61
- >git clone --branch main3 https://github.com/snowtafir/yuki-plugin.git ./plugins/yuki-plugin
62
- >```
66
+ ### ***(二)Yunzai-V3***
63
67
 
64
- #### 2. 安装依赖
65
- * Yunzai-Next:
68
+ > 仅支持Yunzai-V3(TRSS/Miao)的分支,选择仓库,安装到 `yunzai/plugins`:
66
69
 
67
- 方式2(V3的方式)安装则需要执行:
70
+ gitee仓库:
68
71
  ```
69
- yarn install
72
+ git clone --branch main3 https://gitee.com/snowtafir/yuki-plugin.git ./plugins/yuki-plugin
70
73
  ```
71
74
 
72
- * Yunzai-V3:
75
+ github仓库:
73
76
  ```
77
+ git clone --branch main3 https://github.com/snowtafir/yuki-plugin.git ./plugins/yuki-plugin
78
+ ```
79
+
80
+ * 安装依赖
81
+
82
+ ```shell
74
83
  pnpm install --filter=yuki-plugin
75
84
  ```
76
85
 
77
- ## 📦插件配置
86
+ # 📦二、插件配置
78
87
 
79
88
  > [!IMPORTANT]
80
89
  > 统一的配置文件路径:
81
90
 
82
91
  `Yunzai/data/yuki-plugin/config/`,启动一次后,即可查看配置文件。
83
92
 
84
- ### 1.B站动态功能:
85
- 使用建议先绑定B站账号或配置cookie,绑定后即可使用相关功能。
93
+ ### (一)B站动态功能:
94
+ 使用前建议先绑定B站账号或配置cookie,绑定后即可使用相关功能。
86
95
 
87
- > **CK优先级:** **#添加B站CK** > ***#扫码B站登录*** > 自动ck
96
+ > **CK优先级:** **#添加B站CK** > ***#扫码B站登录*** > 自动ck。`只有删除前一个,后一个才生效,删除方法见功能指令。`
88
97
 
89
- `只有删除前一个,后一个才生效,删除方法见功能指令。`
98
+ #### 1)绑定账号(推荐):
99
+ `#扫码B站登录`,获取B站登录CK。取消使用登录则发送:`#删除B站登录`
90
100
 
91
- #### (1) 绑定账号(推荐):`#扫码B站登录`,获取B站登录CK。取消使用登录则发送:`#删除B站登录`
92
- #### (2) 手动配置本地Cookie(可选):
101
+ #### 2)手动配置本地Cookie(可选):
93
102
  私聊/私信 Bot下发送`#添加B站CK: xxx` 添加本地浏览器 无痕模式下 登录b站 获取的B站cookie。
94
103
 
95
- <details> <summary>本地CK获取方法:</summary>
104
+ <details> <summary>本地CK获取方法:</summary>
96
105
 
97
106
  ***注意事项:***
98
107
  > 你平常使用浏览器访问 b 站为普通模式,cookie会定期自动刷新而导致复制的旧ck一段时间就失效,你应该使用`隐私窗口/无痕式窗口`重新登录b站,并获取新的 cookie。
@@ -111,17 +120,19 @@ pnpm install --filter=yuki-plugin
111
120
  > [!TIP]
112
121
  > 保存目录:`Yunzai/data/yuki-plugin/biliCookie.yaml`,如需更换/更新cookie 使用新的cookie发送`#添加B站CK: xxx`覆盖绑定即可。停用手动本地ck则发送命令:`#删除B站ck`
113
122
 
114
- ### 2.微博动态功能:
115
- #### (1) 获取微博博主uid:
116
- >博主主页如:
123
+ ### (二)微博动态功能:
124
+ * 获取微博博主uid:
125
+
126
+ 博主主页如:
117
127
  ```
118
128
  https://m.weibo.cn/u/6593199887 # 6593199887 为原神博主uid
119
129
  https://m.weibo.cn/u/7643376782 # 7643376782 为崩坏星穹铁道博主uid
120
130
  ```
121
- > 或打开微博app,进入博主主页,右上角点击分享,复制分享链接,在链接里找到相应uid。
122
- > 微博限制,可能连续获取动态会出现获取连接中断报错,待定时任务自动重试即可。
131
+ 或打开微博app,进入博主主页,右上角点击分享,复制分享链接,在链接里找到相应uid。
132
+
133
+ 微博限制,可能连续获取动态会出现获取连接中断报错,待定时任务自动重试即可。
123
134
 
124
- ## 🌈功能列表
135
+ # 🌈 三、功能列表
125
136
 
126
137
  请使用 `优纪帮助`或 `yuki帮助` 获取完整帮助
127
138
 
@@ -129,9 +140,9 @@ https://m.weibo.cn/u/7643376782 # 7643376782 为崩坏星穹铁道博主uid
129
140
  - [x] 微博动态
130
141
 
131
142
 
132
- ## 🚀指令列表
143
+ # 🚀 四、指令列表
133
144
 
134
- <details><summary>点击展开</summary>
145
+ <details><summary>指令列表,点击展开</summary>
135
146
 
136
147
  > [!TIP]
137
148
  > 指令前缀:`#优纪`、`#yuki`、`/优纪`、`/yuki`,
@@ -173,20 +184,19 @@ https://m.weibo.cn/u/7643376782 # 7643376782 为崩坏星穹铁道博主uid
173
184
 
174
185
  </details>
175
186
 
176
- ### 🌟 样式预览
177
- <details><summary>点击展开</summary>
187
+ <details><summary>样式预览,点击展开</summary>
178
188
 
179
189
  ![](/resources/img/readme/mini-help.jpg)
180
190
 
181
191
  </details>
182
192
 
183
- ## 支持与贡献
193
+ # 🧩 五、支持与贡献
184
194
 
185
195
  如果你喜欢这个项目,请不妨点个 Star🌟,这是对开发者最大的动力,呜咪~❤️
186
196
 
187
197
  有意见或者建议也欢迎提交 [Issues](https://github.com/snowtafir/yuki-plugin/issues) 和 [Pull requests](https://github.com/snowtafir/yuki-plugin/pulls)。
188
198
 
189
- ## license/声明
199
+ # 🌟 六、license/声明
190
200
  - this project is inspired by [trss-xianxin-plugin](https://github.com/snowtafir/xianxin-plugin)
191
201
  - 基于 `MIT` 协议开源,但有如下额外限制:
192
202
  1. 其中`resources/img/icon/`目录下的素材来源于网络,不保证商业使用,请遵守相关版权法律,如有侵权请联系本人删除。
@@ -194,7 +204,7 @@ https://m.weibo.cn/u/7643376782 # 7643376782 为崩坏星穹铁道博主uid
194
204
  3. ```严禁用于非法行为```
195
205
 
196
206
 
197
- ## 🔗 链接/致谢
207
+ # 🔗 七、链接/致谢
198
208
 
199
209
  | Nickname | Contribution |
200
210
  | :-----------------------------------------------------------------: | ----------------------- |
@@ -58,7 +58,6 @@ message.use(async (e) => {
58
58
  if (code === -352) {
59
59
  e.reply(`遭遇风控,该uid的主页空间动态内容检查失败~\n请检查Cookie配置后再试~\n将跳过校验并保存订阅,请自行检查uid是否正确。`);
60
60
  logger.mark(`yuki-plugin addDynamicSub Failed:${JSON.stringify(res.data)}`);
61
- return true;
62
61
  }
63
62
  const { has_more, items } = data || {};
64
63
  let infoName;
@@ -72,11 +71,9 @@ message.use(async (e) => {
72
71
  const { code, data } = resp.data || {};
73
72
  if (code === -400) {
74
73
  e.reply("发起uid检验请求错误~\n将跳过校验并保存订阅,请自行检查uid是否正确。");
75
- return true;
76
74
  }
77
75
  else if (code === -403) {
78
76
  e.reply("可能是Cookie过期或api参数错误,\n访问权限不足,发起uid检验失败。\n将跳过校验并保存订阅,请自行检查uid是否正确。");
79
- return true;
80
77
  }
81
78
  else if (code === -404) {
82
79
  e.reply(`经过校验,该用户不存在,\n输入的uid: ${uid} 无效。订阅失败。`);
@@ -85,12 +82,8 @@ message.use(async (e) => {
85
82
  else {
86
83
  infoName = data?.name;
87
84
  e.reply(`昵称:${infoName} \nuid:${uid} 校验成功!`);
88
- return true;
89
85
  }
90
86
  }
91
- else if (code === 0 && (has_more === true)) {
92
- return true;
93
- }
94
87
  let name;
95
88
  if (Array.isArray(items)) {
96
89
  if (items.length > 0) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yz-yuki-plugin",
3
- "version": "2.0.3-2",
3
+ "version": "2.0.3-4",
4
4
  "description": "优纪插件,yunzaijs 关于 微博推送、B站推送 等功能的拓展插件",
5
5
  "author": "snowtafir",
6
6
  "type": "module",