koishi-plugin-bilibili-notify 1.0.0-rc.2 → 1.0.1

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Akokko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/biliAPI.d.ts

@@ -1,5 +1,6 @@
 import { Context, Service } from "koishi";
 import { CookieJar } from 'tough-cookie';
+import { Notifier } from "@koishijs/plugin-notifier";
 declare module 'koishi' {
     interface Context {
         biliAPI: BiliAPI;
@@ -10,6 +11,7 @@ declare class BiliAPI extends Service {
     jar: CookieJar;
     client: any;
     loginData: any;
+    loginNotifier: Notifier;
     constructor(ctx: Context);
     protected start(): void | Promise<void>;
     getTimeNow(): Promise<any>;
@@ -21,6 +23,7 @@ declare class BiliAPI extends Service {
     getLoginStatus(qrcodeKey: string): Promise<any>;
     getLiveRoomInfo(roomId: string): Promise<any>;
     getMasterInfo(mid: string): Promise<any>;
+    disposeNotifier(): void;
     createNewClient(): void;
     getCookies(): string;
     loadCookiesFromDatabase(): Promise<void>;

package/lib/biliAPI.js

@@ -8,7 +8,7 @@ const axios_1 = __importDefault(require("axios"));
 const tough_cookie_1 = require("tough-cookie");
 const axios_cookiejar_support_1 = require("axios-cookiejar-support");
 const jsdom_1 = require("jsdom");
-const GET_DYNAMIC_LIST = 'https://api.bilibili.com/x/polymer/web-dynamic/v1/feed/all';
+// const GET_DYNAMIC_LIST = 'https://api.bilibili.com/x/polymer/web-dynamic/v1/feed/all'
 const GET_USER_SPACE_DYNAMIC_LIST = 'https://api.bilibili.com/x/polymer/web-dynamic/v1/feed/space';
 const GET_COOKIES_INFO = 'https://passport.bilibili.com/x/passport-login/web/cookie/info';
 const GET_USER_INFO = 'https://api.bilibili.com/x/space/wbi/acc/info';
@@ -19,10 +19,11 @@ const GET_LIVE_ROOM_INFO = 'https://api.live.bilibili.com/room/v1/Room/get_info'
 const GET_MASTER_INFO = 'https://api.live.bilibili.com/live_user/v1/Master/info';
 const GET_TIME_NOW = 'https://api.bilibili.com/x/report/click/now';
 class BiliAPI extends koishi_1.Service {
-    static inject = ['database', 'wbi'];
+    static inject = ['database', 'wbi', 'notifier'];
     jar;
     client;
     loginData;
+    loginNotifier;
     constructor(ctx) {
         super(ctx, 'biliAPI');
     }
@@ -117,6 +118,7 @@ class BiliAPI extends koishi_1.Service {
             throw new Error('网络异常，本次请求失败！');
         }
     }
+    disposeNotifier() { this.loginNotifier && this.loginNotifier.dispose(); }
     createNewClient() {
         this.jar = new tough_cookie_1.CookieJar();
         this.client = (0, axios_cookiejar_support_1.wrapper)(axios_1.default.create({ jar: this.jar, headers: { 'Content-Type': 'application/json' } }));
@@ -133,11 +135,30 @@ class BiliAPI extends koishi_1.Service {
     async loadCookiesFromDatabase() {
         // 读取数据库获取cookies
         const data = (await this.ctx.database.get('loginBili', 1))[0];
-        // 没有数据则直接返回
-        if (data === undefined)
+        // 判断是否登录
+        if (data === undefined) { // 没有数据则直接返回
+            // 未登录，在控制台提示
+            this.loginNotifier = this.ctx.notifier.create({
+                type: 'warning',
+                content: '您尚未登录，将无法使用插件提供的指令'
+            });
+            return;
+        }
+        // 定义解密信息
+        let decryptedCookies;
+        let decryptedRefreshToken;
+        try {
+            // 解密数据
+            decryptedCookies = this.ctx.wbi.decrypt(data.bili_cookies);
+            // 解密refresh_token
+            decryptedRefreshToken = this.ctx.wbi.decrypt(data.bili_refresh_token);
+        }
+        catch (e) {
+            // 解密失败，删除数据库登录信息
+            await this.ctx.database.remove('loginBili', [1]);
+            // 直接返回
             return;
-        // 解密数据
-        const decryptedCookies = this.ctx.wbi.decrypt(data.bili_cookies);
+        }
         // 解析从数据库读到的cookies
         const cookies = JSON.parse(decryptedCookies);
         // 定义CSRF Token
@@ -160,10 +181,10 @@ class BiliAPI extends koishi_1.Service {
             });
             this.jar.setCookieSync(cookie, `http${cookie.secure ? 's' : ''}://${cookie.domain}${cookie.path}`, {});
         });
-        // 解密refresh_token
-        const decryptedRefreshToken = this.ctx.wbi.decrypt(data.bili_refresh_token);
-        // Check if token need refresh
-        this.checkIfTokenNeedRefresh(decryptedRefreshToken, csrf);
+        // Open scheduled tasks and check if token need refresh
+        this.ctx.setInterval(() => {
+            this.checkIfTokenNeedRefresh(decryptedRefreshToken, csrf);
+        }, 43200000);
     }
     async checkIfTokenNeedRefresh(refreshToken, csrf, times = 0) {
         let data;
@@ -204,22 +225,30 @@ class BiliAPI extends koishi_1.Service {
         const refresh_csrf = targetElement ? targetElement.textContent : null;
         // 发送刷新请求
         const { data: refreshData } = await this.client.post('https://passport.bilibili.com/x/passport-login/web/cookie/refresh', {
-            csrf,
+            csrf: csrf.trim(),
             refresh_csrf,
             source: 'main_web',
             refresh_token: refreshToken
         });
+        const notifyAndError = (info) => {
+            // 设置控制台通知
+            this.loginNotifier = this.ctx.notifier.create({
+                type: 'warning',
+                content: info
+            });
+            throw new Error(info);
+        };
         // 检查是否有其他问题
         switch (refreshData.code) {
             // 账号未登录
             case -101: return this.createNewClient();
             case -111: {
                 await this.ctx.database.remove('loginBili', [1]);
-                throw new Error('csrf 校验失败');
+                notifyAndError('csrf 校验错误，请重新登录');
             }
             case 86095: {
                 await this.ctx.database.remove('loginBili', [1]);
-                throw new Error('refresh_csrf 错误或 refresh_token 与 cookie 不匹配');
+                notifyAndError('refresh_csrf 错误或 refresh_token 与 cookie 不匹配，请重新登录');
             }
         }
         // 更新 新的cookies和refresh_token
@@ -247,7 +276,10 @@ class BiliAPI extends koishi_1.Service {
         });
         // 检查是否有其他问题
         switch (aceeptData.code) {
-            case -111: throw new Error('csrf 校验失败');
+            case -111: {
+                await this.ctx.database.remove('loginBili', [1]);
+                notifyAndError('csrf 校验失败，请重新登录');
+            }
             case -400: throw new Error('请求错误');
         }
         // 没有问题，cookies已更新完成

package/lib/comRegister.d.ts

@@ -23,13 +23,13 @@ declare class ComRegister {
     getSubFromDatabase(ctx: Context): Promise<void>;
     unsubSingle(ctx: Context, id: string, type: number): string;
     checkIfIsLogin(ctx: Context): Promise<boolean>;
-    test_dynamicDetect(ctx: Context, session: Session, uid: string): () => Promise<void>;
 }
 declare namespace ComRegister {
     interface Config {
         pushTime: number;
         liveLoopTime: number;
         dynamicLoopTime: number;
+        dynamicCheckNumber: number;
     }
     const Config: Schema<Config>;
 }

package/lib/comRegister.js

@@ -172,6 +172,8 @@ class ComRegister {
                         }]);
                     // 销毁定时器
                     dispose();
+                    // 清除控制台通知
+                    ctx.biliAPI.disposeNotifier();
                     // 发送成功登录推送
                     await session.send('登录成功！');
                     // 订阅之前的订阅
@@ -244,7 +246,7 @@ class ComRegister {
             .option('live', '-l')
             .option('dynamic', '-d')
             .usage('订阅用户动态和直播通知，若需要订阅直播请加上-l，需要订阅动态则加上-d。若没有加任何参数，之后会向你单独询问，尖括号中为必选参数，中括号为可选参数，目标群号若不填，则默认为当前群聊')
-            .example('bili sub 用户uid 目标QQ群号(暂不支持) -l -d')
+            .example('bili sub 1194210119 目标QQ群号(暂不支持) -l -d 订阅UID为1194210119的UP主的动态和直播')
             .action(async ({ session, options }, mid, guildId) => {
             this.logger.info('调用bili.sub指令');
             // 检查是否登录
@@ -382,7 +384,7 @@ class ComRegister {
             .subcommand('.dynamic <uid:string> <guildId:string>', '订阅用户动态推送', { hidden: true })
             .option('bot', '-b <type:string>')
             .usage('订阅用户动态推送')
-            .example('bili dynamic 1')
+            .example('bili dynamic 1194210119 订阅UID为1194210119的动态')
             .action(async ({ session, options }, uid, guildId) => {
             this.logger.info('调用bili.dynamic指令');
             // 如果uid为空则返回
@@ -411,7 +413,7 @@ class ComRegister {
                 default: return '非法调用';
             }
             // 开始循环检测
-            const dispose = ctx.setInterval(this.dynamicDetect(ctx, bot, guildId, uid), 60000);
+            const dispose = ctx.setInterval(this.dynamicDetect(ctx, bot, guildId, uid), config.dynamicLoopTime * 1000);
             // 将销毁函数保存到订阅管理对象
             this.subManager[index].dynamicDispose = dispose;
         });
@@ -419,7 +421,7 @@ class ComRegister {
             .subcommand('.live <roomId:string> <guildId:string>', '订阅主播开播通知', { hidden: true })
             .option('bot', '-b <type:string>')
             .usage('订阅主播开播通知')
-            .example('bili live 732')
+            .example('bili live 26316137 订阅房间号为26316137的直播间')
             .action(async ({ options }, roomId, guildId) => {
             this.logger.info('调用bili.live指令');
             // 如果room_id为空则返回
@@ -446,7 +448,7 @@ class ComRegister {
                 default: return '非法调用';
             }
             // 开始循环检测
-            const dispose = ctx.setInterval(this.liveDetect(ctx, bot, guildId, roomId), 5000);
+            const dispose = ctx.setInterval(this.liveDetect(ctx, bot, guildId, roomId), config.liveLoopTime * 1000);
             // 保存销毁函数
             this.subManager[index].liveDispose = dispose;
         });
@@ -534,8 +536,8 @@ class ComRegister {
             }
             // 获取数据内容
             const items = content.data.items;
-            // 发送请求 只查看前五条数据
-            for (let num = 4; num >= 0; num--) {
+            // 发送请求 默认只查看前五条数据
+            for (let num = this.config.dynamicCheckNumber - 1; num >= 0; num--) {
                 // 没有动态内容则直接跳过
                 if (!items[num])
                     continue;
@@ -548,11 +550,15 @@ class ComRegister {
                     if (num === 0) {
                         timePoint = items[num].modules.module_author.pub_ts
                      } */
-                    switch (num) {
+                    // 检查最一条动态是否是置顶动态
+                    if (num === 0) {
                         // 如果是置顶动态，则跳过
-                        case 0: if (items[num].modules.module_tag)
+                        if (items[num].modules.module_tag) {
+                            // 将上一条动态的发布时间设为时间点
+                            timePoint = items[num + 1].modules.module_author.pub_ts;
                             continue;
-                        case 1: timePoint = items[num].modules.module_author.pub_ts;
+                        }
+                        timePoint = items[num].modules.module_author.pub_ts;
                     }
                     // 推送该条动态
                     let attempts = 3;
@@ -849,82 +855,13 @@ class ComRegister {
         }
         return false;
     }
-    test_dynamicDetect(ctx, session, uid) {
-        let firstSubscription = true;
-        let timePoint;
-        // Test code
-        let timer = 0;
-        return async () => {
-            // Test code
-            console.log('timer:' + timer++);
-            console.log('firstSubscription:' + firstSubscription);
-            console.log(`timePoint: ${timePoint}`);
-            console.log(`timePoint: ${ctx.gimg.unixTimestampToString(timePoint)}`);
-            // 第一次订阅判断
-            if (firstSubscription) {
-                // 设置第一次的时间点
-                timePoint = Math.floor(Date.now() / 1000);
-                // 设置第一次为false
-                firstSubscription = false;
-                return;
-            }
-            // 获取用户空间动态数据
-            let content;
-            try {
-                content = await ctx.biliAPI.getUserSpaceDynamic(uid);
-            }
-            catch (e) {
-                return this.logger.error('dynamicDetect getUserSpaceDynamic() 网络请求失败');
-            }
-            // 判断是否出现其他问题
-            if (content.code !== 0) {
-                switch (content.code) {
-                    case -101: { // 账号未登录
-                        await session.send('账号未登录，请登录后重新订阅动态');
-                    }
-                    default: { // 未知错误
-                        await session.send('未知错误，请重新订阅动态');
-                    }
-                }
-                // 取消订阅
-                this.unsubSingle(ctx, uid, 1); /* 1为取消动态订阅 */
-                return;
-            }
-            // 获取数据内容
-            const items = content.data.items;
-            // 发送请求 只查看前五条数据
-            for (let num = 4; num >= 0; num--) {
-                // 没有动态内容则直接跳过
-                if (!items[num])
-                    continue;
-                // Test code
-                console.log(`items[${num}].modules.module_author.pub_ts: ${ctx.gimg.unixTimestampToString(items[num].modules.module_author.pub_ts)}`);
-                // 寻找发布时间比时间点时间更晚的动态
-                if (items[num].modules.module_author.pub_ts > timePoint) {
-                    // 如果这是遍历的最后一条，将时间点设置为这条动态的发布时间
-                    /*  if (num === 1) timePoint = items[num].modules.module_author.pub_ts
-                    if (num === 0) {
-                        timePoint = items[num].modules.module_author.pub_ts
-                     } */
-                    switch (num) {
-                        // 如果是置顶动态，则跳过
-                        case 0: if (items[num].modules.module_tag)
-                            continue;
-                        case 1: timePoint = items[num].modules.module_author.pub_ts;
-                    }
-                    // 推送该条动态
-                    const [pic] = await ctx.gimg.generateDynamicImg(items[num]);
-                    await session.send(pic);
-                }
-            }
-        };
-    }
 }
 (function (ComRegister) {
     ComRegister.Config = koishi_1.Schema.object({
         pushTime: koishi_1.Schema.number().required(),
         liveLoopTime: koishi_1.Schema.number().default(10),
-        dynamicLoopTime: koishi_1.Schema.number().default(60)
+        dynamicLoopTime: koishi_1.Schema.number().default(60),
+        dynamicCheckNumber: koishi_1.Schema.number().required()
     });
 })(ComRegister || (ComRegister = {}));
 exports.default = ComRegister;

package/lib/generateImg.js

@@ -25,14 +25,14 @@ const DYNAMIC_TYPE_BANNER = 'DYNAMIC_TYPE_BANNER';
 const DYNAMIC_TYPE_UGC_SEASON = 'DYNAMIC_TYPE_UGC_SEASON';
 const DYNAMIC_TYPE_SUBSCRIPTION_NEW = 'DYNAMIC_TYPE_SUBSCRIPTION_NEW';
 // 内容卡片类型
-const ADDITIONAL_TYPE_NONE = 'ADDITIONAL_TYPE_NONE';
-const ADDITIONAL_TYPE_PGC = 'ADDITIONAL_TYPE_PGC';
-const ADDITIONAL_TYPE_GOODS = 'ADDITIONAL_TYPE_GOODS';
-const ADDITIONAL_TYPE_VOTE = 'ADDITIONAL_TYPE_VOTE';
-const ADDITIONAL_TYPE_COMMON = 'ADDITIONAL_TYPE_COMMON';
-const ADDITIONAL_TYPE_MATCH = 'ADDITIONAL_TYPE_MATCH';
-const ADDITIONAL_TYPE_UP_RCMD = 'ADDITIONAL_TYPE_UP_RCMD';
-const ADDITIONAL_TYPE_UGC = 'ADDITIONAL_TYPE_UGC';
+/* const ADDITIONAL_TYPE_NONE = 'ADDITIONAL_TYPE_NONE'
+const ADDITIONAL_TYPE_PGC = 'ADDITIONAL_TYPE_PGC'
+const ADDITIONAL_TYPE_GOODS = 'ADDITIONAL_TYPE_GOODS'
+const ADDITIONAL_TYPE_VOTE = 'ADDITIONAL_TYPE_VOTE'
+const ADDITIONAL_TYPE_COMMON = 'ADDITIONAL_TYPE_COMMON'
+const ADDITIONAL_TYPE_MATCH = 'ADDITIONAL_TYPE_MATCH'
+const ADDITIONAL_TYPE_UP_RCMD = 'ADDITIONAL_TYPE_UP_RCMD'
+const ADDITIONAL_TYPE_UGC = 'ADDITIONAL_TYPE_UGC' */
 const ADDITIONAL_TYPE_RESERVE = 'ADDITIONAL_TYPE_RESERVE';
 class GenerateImg extends koishi_1.Service {
     static inject = ['puppeteer', 'biliAPI'];

package/lib/index.d.ts

@@ -3,6 +3,8 @@ export declare const inject: string[];
 export declare const name = "bilibili-notify";
 export interface Config {
     pushTime: number;
+    dynamicCheckNumber: number;
+    dynamicLoopTime: '1分钟' | '2分钟' | '3分钟' | '5分钟';
     cardColorStart: string;
     cardColorEnd: string;
     key: string;

package/lib/index.js

@@ -28,8 +28,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.apply = exports.Config = exports.name = exports.inject = void 0;
 const koishi_1 = require("koishi");
-// import crypto
-// import crypto from 'crypto'
 // import plugins
 // import Authority from './authority'
 const comRegister_1 = __importDefault(require("./comRegister"));
@@ -38,7 +36,7 @@ const Database = __importStar(require("./database"));
 const wbi_1 = __importDefault(require("./wbi"));
 const generateImg_1 = __importDefault(require("./generateImg"));
 const biliAPI_1 = __importDefault(require("./biliAPI"));
-exports.inject = ['puppeteer', 'database'];
+exports.inject = ['puppeteer', 'database', 'notifier'];
 exports.name = 'bilibili-notify';
 exports.Config = koishi_1.Schema.object({
     pushTime: koishi_1.Schema.number()
@@ -47,6 +45,17 @@ exports.Config = koishi_1.Schema.object({
         .step(0.5)
         .default(1)
         .description('设定隔多长时间推送一次直播状态，单位为小时，默认为一小时'),
+    dynamicCheckNumber: koishi_1.Schema.number()
+        .min(2)
+        .max(10)
+        .role('slider')
+        .step(1)
+        .default(5)
+        .description('设定每次检查动态的数量。若订阅的UP主经常在短时间内连着发多条动态可以将该值提高，若订阅的UP主有置顶动态，在计算该值时应-1。默认值为5条'),
+    dynamicLoopTime: koishi_1.Schema.union(['1分钟', '2分钟', '3分钟', '5分钟'])
+        .role('')
+        .default('2分钟')
+        .description('设定多久检测一次动态。若需动态的时效性，可以设置为1分钟。若订阅的UP主经常在短时间内连着发多条动态应该将该值提高，否则会出现动态漏推送和晚推送的问题，默认值为2分钟'),
     cardColorStart: koishi_1.Schema.string()
         .pattern(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
         .default('#F38AB5')
@@ -62,6 +71,9 @@ exports.Config = koishi_1.Schema.object({
         .description('请输入一个32位小写字母的十六进制密钥（例如：9b8db7ae562b9864efefe06289cc5530），使用此密钥将你的B站登录信息存储在数据库中，请一定保存好此密钥。如果你忘记了此密钥，必须重新登录。你可以自行生成，或到这个网站生成：https://www.sexauth.com/')
 });
 function apply(ctx, config) {
+    ctx.notifier.create({
+        content: '请记得使用Auth插件创建超级管理员账号，没有权限将无法使用该插件提供的指令。'
+    });
     // load database
     ctx.plugin(Database);
     // Regist server
@@ -70,7 +82,23 @@ function apply(ctx, config) {
     ctx.plugin(biliAPI_1.default);
     // load plugin
     // ctx.plugin(Authority)
-    ctx.plugin(comRegister_1.default, { pushTime: config.pushTime });
+    // 转换为具体时间
+    let dynamicLoopTime;
+    switch (config.dynamicLoopTime) {
+        case '1分钟':
+            dynamicLoopTime = 60;
+            break;
+        case '2分钟':
+            dynamicLoopTime = 120;
+            break;
+        case '3分钟':
+            dynamicLoopTime = 180;
+            break;
+        case '5分钟':
+            dynamicLoopTime = 300;
+            break;
+    }
+    ctx.plugin(comRegister_1.default, { pushTime: config.pushTime, dynamicCheckNumber: config.dynamicCheckNumber, dynamicLoopTime });
     // 当用户输入“恶魔兔，启动！”时，执行 help 指令
     ctx.middleware((session, next) => {
         if (session.content === '恶魔兔，启动！') {
@@ -82,6 +110,3 @@ function apply(ctx, config) {
     });
 }
 exports.apply = apply;
-/* function generateKey(): string {
-  return crypto.randomBytes(32).toString('hex');
-} */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-bilibili-notify",
   "description": "Koishi bilibili notify plugin",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.1",
   "contributors": [
     "Akokko <admin@akokko.com>"
   ],
@@ -16,6 +16,7 @@
     "type": "git",
     "url": "git+https://github.com/Akokk0/koishi-plugin-bilibili-notify"
   },
+  "homepage": "https://www.npmjs.com/package/koishi-plugin-bilibili-notify",
   "scripts": {},
   "keywords": [
     "chatbot",
@@ -37,15 +38,15 @@
     "koishi-plugin-puppeteer": "^3.7.3"
   },
   "koishi": {
-    "preview": true,
     "service": {
       "required": [
         "database",
-        "puppeteer"
+        "puppeteer",
+        "notifier"
       ]
     },
     "description": {
-      "zh": "开发中的Bilibili直播通知，动态推送插件。目前还只是个雏形，不建议使用，发布做测试用"
+      "zh": "Bilibili动态推送，直播通知插件。具体使用方法请参考readme.md"
     },
     "locales": [
       "zh"

package/readme.md

@@ -1,15 +1,89 @@
-# koishi-plugin-bilibili-notify
+<div align="center">
+# Bilibili-Botify
+</div>
 
-[![npm](https://img.shields.io/npm/v/koishi-plugin-bilibili-notify?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-bilibili-notify)
 
-此插件依赖于"database"和"puppeteer"服务，同时受权限控制，需要具备authority:3及以上的权限才能使用本插件提供的指令，你可以参考下面链接中的方法得到一个超级管理员账号（具有authority:5的最高权限）
-https://koishi.chat/zh-CN/manual/usage/platform.html#%E9%85%8D%E7%BD%AE%E7%99%BB%E5%BD%95%E6%8F%92%E4%BB%B6
+基于 [koishi](../../../../koishijs/koishi) 框架的B站推送插件
 
-您还可以安装admin插件，给其他用户授予权限，操作方法请参考下面的链接
-https://koishi.chat/zh-CN/manual/usage/customize.html
+---
 
-指令使用方法请参考 help bili，子命令使用方法请加-h，例如bili login -h
+- **koishi-plugin-bilibili-notify** [![npm](https://img.shields.io/npm/v/koishi-plugin-bilibili-notify?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-bilibili-notify)
+  - [功能](#功能)
+  - [安装](#安装)
+  - [使用方法](#使用方法)
+  - [注意事项](#注意事项)
+  - [感谢](#感谢)
+  - [License](#License)
 
-本插件功能均建立在B站账号登录之上，所有操作之前请先登录
+## 功能
 
-登录方式为二维码，输入命令bili login之后扫码登录，您的登录凭证将存储在您的本地数据库，并由您自己填写的密钥加密，所以请保管好你的密钥
+订阅B站UP主动态
+
+订阅B站UP主直播
+
+## 安装
+
+1. 下载插件运行平台 [Koishi](https://koishi.chat/)
+2. 在插件平台的 **`插件市场`** 中搜索 **`bilibili-notify`** 并安装
+
+## 使用方法
+
+登录B站：进行任何操作前，请先登录B站
+
+- 使用指令 `bili login` 获取登录二维码，使用B站扫码登录
+
+订阅UP主：订阅你想要推送的UP主
+
+- 使用指令 `bili sub <uid>` 订阅需要订阅的UP主
+- 参数说明：`uid` 为必填参数，为 `up主` 的  `uid` 
+- 选项说明：`bili sub <uid>` 有两个选项：-l 和 -d
+  - `-l` 为订阅UP主直播间，包括直播开播通知，定时推送直播内容，下播通知
+  - `-d` 为订阅UP主动态推送，目前实现推送的动态类型有：普通图文动态，转发动态，直播预约动态
+
+- 例如：
+  - `bili sub 1194210119 ` 订阅UID为1194210119的UP主
+  - `bili sub 1194210119 -d` 订阅UID为1194210119的UP主动态推送
+  - `bili sub 1194210119 -ld` 订阅UID为1194210119的UP主动态推送和直播间
+- Tips:
+  - 除非使用指令 `bili sub 1194210119 -ld` ，没有加选项或只加了一个选项的指令都会再次询问是否需要订阅另一项。例如：使用指令 `bili sub 1194210119 -d` 机器人会询问是否需要订阅直播间
+
+取消订阅UP主：取消订阅不需要推送的UP主
+
+- 使用指令 `bili unsub <uid>` 取消订阅不需要订阅的UP主
+- 参数说明：`uid` 为必填参数，为 `up主` 的 `uid`
+- 选项说明：`bili unsub <uid>` 有两个选项：-l 和 -d
+  - `-l` 为取消订阅UP主直播间
+  - `-d` 为取消订阅UP主动态
+- 例如：
+  - `bili unsub 123456` 取消订阅UID为123456的UP主动态推送和直播间
+  - `bili unsub 123456 -d` 取消订阅UID为123456的UP主动态推送
+  - `bili unsub 123456 -dl` 取消订阅UID为123456的UP主动态推送和直播间
+
+查看目前已订阅的UP主：
+
+- 使用指令 `bili show`
+
+## 注意事项
+
+1. 此插件依赖于 `database` 和 `puppeteer` 服务，同时受权限控制，需要具备 `authority:3` 及以上的权限才能使用本插件提供的指令，你可以参考下方配置登录插件中的方法得到一个超级管理员账号（具有 `authority:5` 的最高权限） 
+
+   [配置登录插件](https://koishi.chat/zh-CN/manual/usage/platform.html#%E9%85%8D%E7%BD%AE%E7%99%BB%E5%BD%95%E6%8F%92%E4%BB%B6)
+
+2. 您还可以安装 `admin` 插件，给其他用户授予权限，操作方法请参考下方的权限管理
+
+   [权限管理](https://koishi.chat/zh-CN/manual/usage/customize.html)
+
+3. 指令使用方法请参考 `help bili`，子命令使用方法请加 `-h` ，例如 `bili login -h`
+4. 登录方式为二维码，输入命令 `bili login` 之后扫码登录，您的登录凭证将存储在您的本地数据库，并由您自己填写的密钥加密，所以请保管好你的密钥
+
+## 更新日志
+
+ver 1.0.1 修复了一些bug，提供用户自己选择动态检测时间的选项
+
+## 感谢
+
+感谢 [koishijs](https://github.com/koishijs/koishi) 官方提供的插件开发框架, 以及技术指导
+
+## License
+
+MIT