QQ-Roboter-Rapid-Development-Framework basierend auf dem OneBot-Protokoll
Dokumentation · Herunterladen · Schnellstart · Mitmachen
Ab Version
v2
werden nurJDK 17+
undSpringBoot 3.0.0+
unterstützt.Weitere Informationen finden Sie im Migrationsleitfaden der Projektdokumentation v2.
Wenn Sie Abhängigkeiten einführen, ersetzen Sie bitte die
latest
Version durch die aktuellste Version vonMaven Central
< dependency >
< groupId >com.mikuac</ groupId >
< artifactId >shiro</ artifactId >
< version >latest</ version >
</ dependency >
implementation( " com.mikuac:shiro:latest " )
implementation ' com.mikuac:shiro:latest '
Schreiben Sie die Konfigurationsdatei
application.yaml
oder lesen Sie die erweiterte Konfigurationsdatei
server :
port : 5000
@ Shiro
@ Component
public class ExamplePlugin {
// 更多用法详见 @MessageHandlerFilter 注解源码
// 当机器人收到的私聊消息消息符合 cmd 值 "hi" 时,这个方法会被调用。
@ PrivateMessageHandler
@ MessageHandlerFilter ( cmd = "hi" )
public void fun1 ( Bot bot , PrivateMessageEvent event , Matcher matcher ) {
// 构建消息
String sendMsg = MsgUtils . builder (). face ( 66 ). text ( "Hello, this is shiro demo." ). build ();
// 发送私聊消息
bot . sendPrivateMsg ( event . getUserId (), sendMsg , false );
}
// 如果 at 参数设定为 AtEnum.NEED 则只有 at 了机器人的消息会被响应
@ GroupMessageHandler
@ MessageHandlerFilter ( at = AtEnum . NEED )
public void fun2 ( GroupMessageEvent event ) {
// 以注解方式调用可以根据自己的需要来为方法设定参数
// 例如群组消息可以传递 GroupMessageEvent, Bot, Matcher 多余的参数会被设定为 null
System . out . println ( event . getMessage ());
}
// 同时监听群组及私聊消息 并根据消息类型(私聊,群聊)回复
@ AnyMessageHandler
@ MessageHandlerFilter ( cmd = "say hello" )
public void fun3 ( Bot bot , AnyMessageEvent event ) {
bot . sendMsg ( event , "hello" , false );
}
}
plugin-list
definiert werdenresources/application.yaml
hinzuMESSAGE_BLOCK
werden nachfolgende Plug-Ins nicht ausgeführt.Schreiben Sie die Konfigurationsdatei
application.yaml
oder lesen Sie die erweiterte Konfigurationsdatei
server :
port : 5000
shiro :
plugin-list :
- com.example.bot.plugins.ExamplePlugin
@ Component
public class ExamplePlugin extends BotPlugin {
@ Override
public int onPrivateMessage ( Bot bot , PrivateMessageEvent event ) {
if ( "hi" . equals ( event . getMessage ())) {
// 构建消息
String sendMsg = MsgUtils . builder ()
. face ( 66 )
. text ( "hello, this is shiro example plugin." )
. build ();
// 发送私聊消息
bot . sendPrivateMsg ( event . getUserId (), sendMsg , false );
}
// 返回 MESSAGE_IGNORE 执行 plugin-list 下一个插件,返回 MESSAGE_BLOCK 则不执行下一个插件
return MESSAGE_IGNORE ;
}
@ Override
public int onGroupMessage ( Bot bot , GroupMessageEvent event ) {
if ( "hi" . equals ( event . getMessage ())) {
// 构建消息
String sendMsg = MsgUtils . builder ()
. at ( event . getUserId ())
. face ( 66 )
. text ( "hello, this is shiro example plugin." )
. build ();
// 发送群消息
bot . sendGroupMsg ( event . getGroupId (), sendMsg , false );
}
// 返回 MESSAGE_IGNORE 执行 plugin-list 下一个插件,返回 MESSAGE_BLOCK 则不执行下一个插件
return MESSAGE_IGNORE ;
}
}
Shiro wurde unter Verwendung des OneBot-v11-Standardprotokolls entwickelt und ist mit allen OneBot-Protokoll-Clients kompatibel, die Reverse WebSocket unterstützen.
Projekt | beschreiben | Bemerkung |
---|---|---|
LLOneBot | Sorgen Sie dafür, dass Ihr NTQQ das OneBot11-Protokoll für die QQ-Roboterentwicklung unterstützt | |
Lagrange.Core | Implementierung des NTQQ-Protokolls | |
go-cqhttp | Native Implementierung von OneBot Golang basierend auf Mirai und MiraiGo | Stoppen Sie die Wartung |
OpenShamrock | Implementieren Sie das OneBot-Standardroboter-Framework basierend auf Xposed |
Weitere Informationen finden Sie unter Mitwirken. Vielen Dank an alle, die bereits beigetragen haben!
Dieses Produkt ist unter der GNU General Public License Version 3 lizenziert. Die Lizenz entspricht der von der Free Software Foundation veröffentlichten Version unter https://www.gnu.org/licenses/gpl-3.0.html.
Alternativ ist dieses Produkt unter der GNU Lesser General Public License Version 3 für die nichtkommerzielle Nutzung lizenziert. Die Lizenz ist wie von der Free Software Foundation veröffentlicht unter https://www.gnu.org/licenses/lgpl-3.0.html .
Wenn Sie Fragen zur Lizenzierung haben oder die Bibliothek in einem kommerziellen Closed-Source-Produkt nutzen möchten, können Sie sich gerne an uns wenden.
JetBrains bietet kostenlose Lizenzen zur Unterstützung von Open-Source-Projekten an.