Среда быстрой разработки роботов QQ на основе протокола OneBot
Документация · Скачать · Быстрый старт · Внести свой вклад
Начиная с версии
v2
поддерживаются толькоJDK 17+
иSpringBoot 3.0.0+
.Подробности см. в руководстве по миграции документации проекта v2.
При вводе зависимостей замените
latest
версию актуальной последней версией изMaven Central
< dependency >
< groupId >com.mikuac</ groupId >
< artifactId >shiro</ artifactId >
< version >latest</ version >
</ dependency >
implementation( " com.mikuac:shiro:latest " )
implementation ' com.mikuac:shiro:latest '
Напишите файл конфигурации
application.yaml
или обратитесь к файлу расширенной конфигурации.
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
resources/application.yaml
MESSAGE_BLOCK
последующие плагины не будут выполняться.Напишите файл конфигурации
application.yaml
или обратитесь к файлу расширенной конфигурации.
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 разработан с использованием стандартного протокола OneBot-v11 и совместим со всеми клиентами протокола OneBot, поддерживающими обратный WebSocket.
проект | описывать | Примечание |
---|---|---|
LLOneBot | Обеспечьте поддержку NTQQ протокола OneBot11 для разработки роботов QQ. | |
Лагранж.Ядро | Реализация протокола NTQQ | |
go-cqhttp | Собственная реализация OneBot Golang на основе Mirai и MiraiGo | Остановить обслуживание |
OpenShamrock | Внедрить стандартную платформу роботов OneBot на основе Xposed. |
Подробнее см. в разделе «Внесение вклада». Спасибо всем, кто уже внес свой вклад!
Этот продукт распространяется под лицензией GNU General Public License версии 3. Лицензия опубликована Фондом свободного программного обеспечения по адресу https://www.gnu.org/licenses/gpl-3.0.html.
Альтернативно, этот продукт лицензируется в соответствии с GNU Lesser General Public License версии 3 для некоммерческого использования. Лицензия опубликована Фондом свободного программного обеспечения по адресу https://www.gnu.org/licenses/lgpl-3.0.html. .
Не стесняйтесь обращаться к нам, если у вас есть какие-либо вопросы о лицензировании или вы хотите использовать библиотеку в коммерческом продукте с закрытым исходным кодом.
JetBrains предлагает бесплатные лицензии для поддержки проектов с открытым исходным кодом.