jerrita / anon

高效率 QQ 机器人框架，支持 OneBot 11 以及 OpenShamrock 私有协议

Anon Framework

开发中

这是 QQ Bot 框架 saaya 的 next 版本，用于对接 OpenShamrock 的 OneBot 协议变体。

OneBot Connect 支持

• 正向 WebSocket

快速开始

本项目采用代码内文档形式，插件开发请采用 PyCharm 获得良好的体验。

OpenShamrock 部署

略，你需要打开 正向 Websocket 并暴露出可被 anon 访问的接口

插件开发规范

基本入口文件如 main.py, 你可以通过 register_plugin 来基于当前目录注册插件:

import logging

from anon import Bot
from anon.logger import logger

logger.setLevel(logging.DEBUG)

if __name__ == '__main__':
    anon = Bot('192.168.5.145:5800', '114514')
    anon.register_plugins([
        'plugins.example.ping',
        'plugins.example.reply'
    ])
    anon.loop()

你可以采用以下两种方式编写插件：

1. 匿名插件

from anon.plugin import PluginManager
from anon.event import MessageEvent

pm = PluginManager()


@pm.register_event([MessageEvent])
async def ping(event: MessageEvent):
    if event.raw == 'ping':
        await event.reply('pong')

2. 自定义插件类型

from anon.plugin import Plugin, PluginManager
from anon.event import MessageEvent
from anon.logger import logger
from anon import Bot


class MyPlugin(Plugin):
    async def on_load(self):
        logger.info('My plugin loaded!')
        # 暴力获取 Bot 实例
        await Bot().send_private_message(114514191, 'Bot started!')

    async def on_event(self, event: MessageEvent):
        if event.raw == 'ping':
            await event.reply('pong')


# 过滤 MessageEvent 给 on_event
PluginManager().register_plugin(MyPlugin([MessageEvent]))

3. 你也可以直接使用 CMD 事件 进行快速开发，例如

import datetime

from anon.event import MessageEvent
from anon.plugin import PluginManager

date_usage = """Usage: date
此命令无需任何参数"""


@PluginManager().register_cmd(['date', '几点了'], brif='获取现在的时间',
                              usage=date_usage)
async def date(event: MessageEvent, args):
    await event.reply(str(datetime.datetime.now()))

设计参考文档

参见 docs

启动方式

1. 混合模式

直接基于此 Repo 进行开发

git clone https://github.com/jerrita/anon --depth=1
git config pull.rebase true # 启用 rebase，上游不会变动 plugins 内容
cd anon && vim plugins      # 写你的插件
vim main.py
gcam "some updates"
pip install -r requirements.txt
python main.py

# 更新方式
git pull

2. Docker 启动

本项目的 docker package 会自动检测 /app 目录，并在没有 anon 的情况下将 package 中的 repo 拷入。

将你插件 repo 挂载到 /app 下即可，/app/.installed 文件标志 /app/requirements.txt 有无安装

mkdir repo && cd repo
vim main.py
mkdir -p plugins/yourname
vim plugins/yourname/name.py
echo "requests" > requirements.txt
docker run --name anon \
  --network host \
  -v ${PWD}:/app \
  -itd ghcr.io/jerrita/anon:latest

Roadmap

• 基础功能 (插件系统，基本组件)
• 容器化部署
• Command Manager
• 文件上传
• 权限管理
• 元事件/系统消息
• ???

Resources

• OpenShamrock