LinkZone

Appearance

示例插件 ​

以下是一系列由简到繁的示例插件，涵盖 LinkZone 插件开发的主要功能。

1. 最简回声插件（函数式） ​

javascript
module.exports = {
    metadata: {
        name: 'echo',
        version: '1.0.0',
        description: '回声插件',
        triggers: [{ type: 0, pattern: '/echo' }]
    },
    async handleEvent(sender) {
        const text = sender.getMessage().replace('/echo', '').trim();
        await sender.reply(text || '请输入内容');
    }
};

2. 问候插件（类式） ​

javascript
class HelloPlugin extends Plugin {
    async handleEvent(sender) {
        const name = sender.getSenderName();
        const isGroup = sender.isGroup();

        if (isGroup) {
            await sender.reply([
                LinkZone.segment.at(sender.getSenderId()),
                LinkZone.segment.text(` 你好，${name}！`)
            ]);
        } else {
            await sender.reply(`你好，${name}！`);
        }
    }
}

HelloPlugin.metadata = {
    name: 'hello',
    version: '1.0.0',
    description: '问候插件',
    triggers: [{ type: 0, pattern: '/hello' }],
    adapter_events: ['message']
};

module.exports = HelloPlugin;

3. 关键词回复插件 ​

javascript
module.exports = {
    metadata: {
        name: 'mood',
        version: '1.0.0',
        description: '心情回复',
        triggers: [
            { type: 1, pattern: '开心' },
            { type: 1, pattern: '难过' },
            { type: 1, pattern: '生气' }
        ]
    },
    async handleEvent(sender) {
        const msg = sender.getMessage();
        if (msg.includes('开心')) {
            await sender.reply('太好了！保持好心情');
        } else if (msg.includes('难过')) {
            await sender.reply('别难过，一切都会好起来的');
        } else if (msg.includes('生气')) {
            await sender.reply('深呼吸，冷静一下');
        }
    }
};

4. 正则匹配插件 ​

javascript
module.exports = {
    metadata: {
        name: 'dice',
        version: '1.0.0',
        description: '掷骰子',
        triggers: [{ type: 2, pattern: '^r(\\d+)?d(\\d+)$' }]
    },
    async handleEvent(sender) {
        const count = parseInt(await sender.param(0)) || 1;
        const sides = parseInt(await sender.param(1)) || 6;

        const results = [];
        for (let i = 0; i < Math.min(count, 10); i++) {
            results.push(Math.floor(Math.random() * sides) + 1);
        }

        const total = results.reduce((a, b) => a + b, 0);
        await sender.reply(
            `掷了 ${count} 个 ${sides} 面骰子: [${results.join(', ')}] = ${total}`
        );
    }
};

5. 多轮对话插件 ​

javascript
class GuessNumberPlugin extends Plugin {
    async handleEvent(sender) {
        const target = Math.floor(Math.random() * 100) + 1;
        await sender.reply('我想了一个 1-100 的数字，猜猜看！');

        let attempts = 0;
        while (attempts < 7) {
            const result = await sender.listen({
                timeout: 60000,
                cancelKeywords: ['不玩了', '退出']
            });

            if (result.timeout || result.cancelled) {
                await sender.reply(`游戏结束！答案是 ${target}`);
                return;
            }

            const guess = parseInt(result.sender.getMessage());
            if (isNaN(guess)) {
                await sender.reply('请输入数字');
                continue;
            }

            attempts++;
            if (guess === target) {
                await sender.reply(`恭喜猜对了！用了 ${attempts} 次`);
                return;
            } else if (guess < target) {
                await sender.reply('太小了，再猜');
            } else {
                await sender.reply('太大了，再猜');
            }
        }

        await sender.reply(`7 次都没猜对，答案是 ${target}`);
    }
}

GuessNumberPlugin.metadata = {
    name: 'guess-number',
    version: '1.0.0',
    description: '猜数字游戏',
    triggers: [{ type: 0, pattern: '/guess' }]
};

module.exports = GuessNumberPlugin;

6. 定时任务插件 ​

javascript
class MorningPlugin extends Plugin {
    async onStart() {
        LinkZone.logger.info('morning', '早安插件已启动');
    }

    async onCron() {
        const greetings = [
            '早上好！新的一天开始了',
            '早安！今天也要加油哦',
            'Good Morning！'
        ];
        const greeting = greetings[Math.floor(Math.random() * greetings.length)];
        await LinkZone.push('qq', 'group_123', greeting);
    }
}

MorningPlugin.metadata = {
    name: 'morning-greeting',
    version: '1.0.0',
    description: '每日早安问候',
    cron: '0 8 * * *',
    is_service: true
};

module.exports = MorningPlugin;

7. 数据库使用插件 ​

javascript
class CounterPlugin extends Plugin {
    async handleEvent(sender) {
        const userId = sender.getSenderId();
        const key = `count_${userId}`;

        let count = await this.db.get('counter', key) || 0;
        count++;
        await this.db.set('counter', key, count);

        await sender.reply(`你已使用 ${count} 次`);
    }
}

CounterPlugin.metadata = {
    name: 'counter',
    version: '1.0.0',
    description: '计数器',
    triggers: [{ type: 0, pattern: '/count' }]
};

module.exports = CounterPlugin;

8. AI 工具插件（直接调用） ​

javascript
class CalculatorPlugin extends Plugin {
    async executeTool(sender, args) {
        const { expression } = args;
        try {
            // 简单安全计算
            const sanitized = expression.replace(/[^0-9+\-*/().%\s]/g, '');
            const result = Function('"use strict"; return (' + sanitized + ')')();
            return {
                success: true,
                content: `${expression} = ${result}`
            };
        } catch (err) {
            return {
                success: false,
                error: `计算错误: ${err.message}`
            };
        }
    }
}

CalculatorPlugin.metadata = {
    name: 'calculator',
    version: '1.0.0',
    description: '计算器',
    ai: {
        tool: {
            parameters: [
                { name: 'expression', type: 'string', description: '数学表达式', required: true }
            ],
            usage: '数学计算器，支持加减乘除',
            when_to_use: '用户需要进行数学计算时'
        }
    }
};

module.exports = CalculatorPlugin;

9. AI 触发插件（注入调用） ​

javascript
class TranslatePlugin extends Plugin {
    async handleEvent(sender) {
        const text = await sender.param(0);
        const targetLang = await sender.param(1) || 'en';

        const config = await sender.getConfig();
        const result = await fetch(
            'https://api.translate.com/v2',
            {
                method: 'POST',
                headers: { Authorization: `Bearer ${config.api_key}` },
                body: JSON.stringify({ text, target: targetLang })
            }
        );

        await sender.reply(result.translatedText);
    }
}

TranslatePlugin.metadata = {
    name: 'translate',
    version: '1.0.0',
    description: '翻译插件',
    triggers: [{ type: 0, pattern: '/translate' }],
    ai: {
        inject: {
            usage: '翻译文本到指定语言',
            format: '/translate {text} {lang}',
            args: {
                text: '要翻译的文本',
                lang: '目标语言（如 en、ja、ko）'
            }
        }
    },
    config_schema: {
        api_key: {
            type: 'string',
            label: '翻译 API Key',
            required: true
        }
    }
};

module.exports = TranslatePlugin;

10. 管理员插件 ​

javascript
class AdminBanPlugin extends Plugin {
    async handleEvent(sender) {
        if (!sender.isAdmin()) {
            await sender.reply('仅管理员可使用此命令');
            return;
        }

        const userId = await sender.param(0);
        const duration = parseInt(await sender.param(1)) || 60;

        if (!userId) {
            await sender.reply('用法: /ban @用户 时长(秒)');
            return;
        }

        await sender.ban(userId, duration);
        await sender.reply(`已禁言 ${userId} ${duration} 秒`);
    }
}

AdminBanPlugin.metadata = {
    name: 'admin-ban',
    version: '1.0.0',
    description: '管理员禁言工具',
    triggers: [{ type: 0, pattern: '/ban' }],
    permission_level: 6
};

module.exports = AdminBanPlugin;

11. 框架事件订阅插件 ​

javascript
class EventMonitorPlugin extends Plugin {
    async onEvent(event) {
        switch (event.name) {
            case 'adapter.connected':
                LinkZone.logger.info('monitor', `适配器已连接: ${event.data.platform}`);
                break;
            case 'adapter.disconnected':
                LinkZone.logger.warn('monitor', `适配器已断开: ${event.data.platform}`);
                break;
            case 'plugin.loaded':
                LinkZone.logger.info('monitor', `插件已加载: ${event.data.name}`);
                break;
            case 'config.changed':
                LinkZone.logger.info('monitor', '配置已变更');
                break;
        }
    }
}

EventMonitorPlugin.metadata = {
    name: 'event-monitor',
    version: '1.0.0',
    description: '框架事件监控',
    subscribe: ['adapter.connected', 'adapter.disconnected', 'plugin.loaded', 'config.changed']
};

module.exports = EventMonitorPlugin;

12. Python 示例 - 回声插件 ​

python
metadata = {
    "name": "echo",
    "version": "1.0.0",
    "description": "Python 回声插件",
    "triggers": [{"type": 0, "pattern": "/echo"}]
}

def handle_event(sender):
    text = sender.get_message().replace("/echo", "").strip()
    sender.reply(text or "请输入内容")

13. Python 示例 - 类式插件 ​

python
metadata = {
    "name": "hello",
    "version": "1.0.0",
    "description": "Python 问候插件",
    "triggers": [{"type": 0, "pattern": "/hello"}],
    "adapter_events": ["message"]
}

class HelloPlugin(Plugin):
    def handle_event(self, sender):
        name = sender.get_sender_name()
        sender.reply(f"你好，{name}！")

14. Python 示例 - 流程控制 ​

python
def handle_event(sender):
    msg = sender.get_message()

    if "禁止词" in msg:
        sender.abort()  # 中止后续插件
        sender.reply("消息已被拦截")
    else:
        sender.continue_()  # 继续执行后续插件（Python 用 continue_）

metadata = {
    "name": "gate",
    "version": "1.0.0",
    "description": "消息门控插件",
    "triggers": [{"type": 1, "pattern": "禁止词"}],
    "priority": -10  # 高优先级
}

15. Python 示例 - 定时任务 ​

python
metadata = {
    "name": "monitor",
    "version": "1.0.0",
    "description": "服务监控插件",
    "is_service": True
}

class MonitorPlugin(Plugin):
    def on_start(self):
        LinkZone.logger.info("monitor", "监控服务启动")
        self.register_cron("health_check", "*/5 * * * *", self.health_check)

    def health_check(self):
        LinkZone.logger.debug("monitor", "健康检查执行")

    def on_stop(self):
        self.unregister_cron("health_check")
        LinkZone.logger.info("monitor", "监控服务停止")

16. Python 示例 - LZDB 使用 ​

python
metadata = {
    "name": "user-score",
    "version": "1.0.0",
    "description": "用户积分插件",
    "triggers": [{"type": 0, "pattern": "/score"}]
}

class UserPlugin(Plugin):
    def handle_event(self, sender):
        user_id = sender.get_sender_id()
        db = LZDB("users")

        # 获取用户积分
        score = db.get(f"{user_id}_score", 0)

        # 增加积分
        score += 10
        db.set(f"{user_id}_score", score)

        sender.reply(f"你的积分: {score}")

基于 MIT 许可发布 | QQ 群：581485581 点击加入

LinkZone Team