Git Product home page Git Product logo

hoyobot-sdk's Introduction

简体中文 License: GPL v3 Maven

HoyoBot-SDK



HoyoSDK

HoyoSDK 是一个在全平台下运行,提供 米游社大别野 协议支持的高效率机器人库

这个项目的名字来源于

米哈游英文名《miHoYo》的后两部分(mi HoYo)

其含义是为米哈游旗下软件米游社创造的项目(HoyoSDK)

  • HoyoSDK 是一个在全平台下运行,提供 米游社大别野 协议支持的高效率机器人库

  • 本项目仍在开发中,请等待正式版再在生产环境中使用

  • 如果你支持这个项目,请给我们一个star. 我们很欢迎社区的贡献


特性

  • 基于Netty | 高性能 | 易开发
  • 开源的 | 跨平台 | 快速开发插件

相关链接

开发者文档
下载
反馈问题
开发相关
官方插件

安装 & 运行

注意: 本框架仅支持 Java17 及以上版本的环境

  • 从Java CI: https://ci.lanink.cn/job/HoyoBot-SDK/
  • 下载最新版构建 sdk-main-1.0.0-jar-with-dependencies.jar
  • (跳转链接): CI
  • 将它放进你的服务器
  • 使用命令 java -jar (下载的文件名) 即可运行

原生命令

HoyoBot自带的命有这些,当然你也可以通过插件注册自定义机器命令.你可以在sdk-api中学习怎么注册一个命令

  • version - 查看机器人及HoyoSDK-Protocol协议版本
  • help - 查看命令帮助
  • plugins - 列出当前机器人安装的插件
  • reload - 热重载机器人插件
  • getvilla - 获取大别野信息
  • getmember - 获取用户信息
  • getroom - 获取房间信息
  • send - 发送自定义消息

构建Jar文件

环境: Kotlin | Java (17)

  • git clone https://github.com/HoyoBot/HoyoBot-SDK.git
  • cd HoyoBot-SDK
  • git submodule update --init
  • ./mvnw clean package
  • 构建好的文件能在目录 target/ directory 中找到.

部署开发环境

  • HoyoBot的插件非常容易开发,这给你的机器人带来了无限的可能性
  • 前往 sdk-api 查看 示例插件

GroupId

  • com.github.HoyoBot.HoyoBot-SDK

Repository可用版本

ArtifactId Version
sdk-main beta
sdk-main beta3
sdk-main beta4
sdk-main beta5
sdk-main beta6
sdk-main beta7
sdk-main beta8
sdk-main beta9
sdk-main beta10
sdk-main beta11

Gradle:

	allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

	dependencies {
	        implementation 'com.github.HoyoBot.HoyoBot-SDK:HoyoBot:beta'
	}

Maven:

Repository:
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
Dependencies:
<dependencies>
    <dependency>
        <groupId>com.github.HoyoBot.HoyoBot-SDK</groupId>
        <artifactId>ExamplePlugin</artifactId>
        <version>beta5</version>
    </dependency>
</dependencies>

协议支持

支持的协议列表

米游社回调事件

  • 消息发送
  • 图片发送
  • 帖子发送
  • 表情发送和管理
  • 成员信息及列表获取
  • 大别野信息及列表获取
  • 踢除用户
  • 消息回复
  • 消息置顶
  • 消息撤回

机器人事件说明

HoyoBot将机器人发生的一切都处理为了事件,若你要开发其插件,只需要注册监听器, 就可以让事件触发时执行你的插件代码

你可以在 sdk-api 中查看样例代码

事件列表

  • ProxyBotStartEvent - 机器人启动事件
  • ProxyBotStopEvent - 机器人关闭事件
  • ProxyPluginEnableEvent - 机器人插件加载事件
  • ProxyRespondEvent - 机器人响应回调事件
  • VillaMemberJoinEvent - 新成员加入频道事件
  • VillaSendMessageEvent - 频道成员聊天事件
  • VillaAddQuickEmotionEvent - 快捷表情添加事件
  • VillaAuditCallbackEvent - 消息审核事件
  • VillaCreateBotEvent - 机器人加入事件
  • VillaDeleteBotEvent - 机器人退出事件

Star History Chart

hoyobot-sdk's People

Contributors

catrainbow233 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

hoyobot-sdk's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.