Skip to content

SaltifyDev/tanebi

Repository files navigation

Out of Development & Looking for Maintainers

由于作者启动了另一基于 Kotlin 的 NTQQ 协议实现项目——Acidify,tanebi 项目将不再维护,V2 的重构也一并暂停。

Acidify 目前已经支持所有 tanebi 已实现的功能,并且在 npm 上也发布了对应的包 @acidify/core,可以直接基于该包使用 TypeScript 进行开发。此外,Acidify 的项目仓库也包含了一个完整的 Milky 协议实现——Yogurt,可以通过 Releases 页面 下载对应平台的可执行文件,同时也以 @acidify/yogurt 的形式发布在 npm 上。

如果你有兴趣继续维护 tanebi 项目并且进行 V2 重构,欢迎通过 Issues、邮件等方式联系作者。


banner

Packages

  • core (npm) - 项目的核心模块,实现基础功能并提供 API
  • milky - 基于 tanebi 的 Milky 协议实现
  • examples - Core API 的使用示例

Tasks

  • pnpm run build - 构建除 examples 以外的所有包
  • pnpm run build:all - 构建所有包
  • pnpm start - 启动 Milky 协议实现
  • pnpm run sea - 打包 Milky 协议实现在对应系统下的可执行文件,生成的文件位于 packages/milky/sea 目录下

Usage

基于 tanebi 的 Core API 使用 TypeScript 开发

通过 npm 等包管理器安装 tanebi,并在你自己的项目中引用。参考 examples 以及源代码中的注释进行开发。

通过 Milky 协议对接其他 Bot 框架

下载 tanebi-milky。

目前尚无稳定 Release,可以在登录 GitHub 账户的前提下下载 Action 中的构建

构建使用 pkg 打包成可执行文件,包含完整的 Node.js 运行时环境。下载后解压,运行 ./tanebi-milky 即可。直接支持的平台有 Windows x64、Linux x64 和 macOS arm64。若要在其他平台上运行,请自行配置 Node.js 环境,克隆仓库,并使用 pnpm start 启动。

Special Thanks

tanebi 离不开以下前辈项目及贡献者:

项目名称源自日语「種火」(たねび),意为火种,向所有先前与当下的 QQ 协议实现致敬。无论是否还在活跃维护,这些项目都是点亮了今天的 QQ Bot 开发的当之无愧的“火种”。

About

[Out of Development & Looking for Maintainers] PC NTQQ 协议的 TypeScript 实现,包含 Milky 协议的实现

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 2

  •  
  •