3.0.21 • Published 10 days ago

zhin v3.0.21

Weekly downloads
-
License
MIT
Repository
github
Last release
10 days ago

zhin

1. 快速上手

  • 安装 & 初始化
# 1. 安装依赖框架
yarn add zhin # or pnpm add zhin
# 2. 安装适配器(目前已支持qq官方机器人和icqq)
yarn add @zhinjs/qq # 如果你需要使用 icqq , 可安装 @zhinjs/icqq
# 2. 初始化配置文件
npx zhin init -m dev
  • 填写配置 打开生成在根目录的 .dev.env 文件，填入相关环境变量
adapters = qq                             # 使用的适配器，多个适配器可用 “,” 分隔
builtPlugins = commandParser,hmr          # 启用的内置插件列表
pluginDirs = plugins                      # 需要加载哪个本地文件夹下的插件，多个文件夹可用 “,” 分隔
  • 目前已内置有 commandParser、hmr、echo、pluginManager 四个插件，其他插件请关注官方仓库和社区插件
  • 启动
  • 注意：首次启动会为你生成对应适配器的默认配置文件，需要您完成配置后再次启动
npx zhin -m dev

插件开发

  • 新建文件testPlugin.js
const {Plugin} = require('zhin')

const testPlugin=new Plugin('test')

// ... 在这儿实现你的逻辑

module.exports=testPlugin

1.定义指令

// 在省略号出调用 testPlugin.command 可以定义一个指令
testPlugin
	.command('/百科 <keyword:string>')
	.action(async(_,keyword)=>{
		const {data}=await axios.get(`https://baike.deno.dev/item/${encodeURIComponent(keyword)}?encoding=text`)
		return data
	})

2. 定义中间件

// 在省略号出调用 testPlugin.middleware 可以往bot中注册一个中间件
testPlugin.middleware((message,next)=>{
	if(!message.raw_message.startsWith('hello')) return next()
    return message.reply('world')
})

3. 定义服务

  • 服务是一个虚拟概念，由插件开发者在插件中声明的特有属性，该属性可暴露给其他插件访问
// 在省略号出调用 testPlugin.service 可以定义一个服务
testPlugin.service('foo','bar')

console.log(testPlugin.foo) // 输出 bar

  • 注意：如果已有之前已加载同名的服务，将不可覆盖已有服务

  • 当插件被加载后，后续加载的插件即可访问到该服务

const {Plugin} = require('zhin')

const helloPlugin=new Plugin('hello')
console.log(helloPlugin.foo) // 输出bar

module.exports=testPlugin
  • 可选：定义服务类型
  • 开发者为服务添加类型声明后，其他人在使用服务时，将获得类型提示
declare module 'zhin'{
    namespace Bot{
        interface Services{
            foo:string
        }
    }
}

使用插件

const {Bot} = require('zhin')
const bot = new Bot({
	// ...
})
bot.mount('[模块名]') // 按模块名称加载插件，将一次查找(./plugins>内置插件>官方插件库>社区插件库>node_modules)目录下对应名称的插件
bot.mount(plugin) // 直接加载对应插件实例
bot.loadFromDir('./plugins', './services') // 加载指定目录下的所有插件，可传入多个目录，将多次加载
bot.loadFromModule('@zhinjs/pluign-guild-manager') // 从模块加载插件，需要你自行安装对应插件包
bot.start()

卸载插件

bot.unmount('[插件名]') // 按插件名卸载对应的插件
bot.unmount(plugin) // 直接卸载对应插件实例
bot.start()
jitidotenvchokidar@zhinjs/core
@everything-registry/sub-chunk-3230@zhinjs/plugin-jsondb@zhinjs/plugin-qa@zhinjs/plugin-render@zhinjs/plugin-sandbox@zhinjs/plugin-schedule@zhinjs/plugin-upyun@zhinjs/qq@zhinjs/web@zhinjs/wechatzhin-plugin-ni-tai-mei@zhinjs/decorator@zhinjs/dingtalk@zhinjs/discord@zhinjs/icqq@zhinjs/onebot-11@zhinjs/onebot-12@zhinjs/plugin-drawer@zhinjs/plugin-game@zhinjs/plugin-group-manage@zhinjs/plugin-guild-manage@zhinjs/plugin-http-server
3.0.21

10 days ago

3.0.20

11 days ago

3.0.19

11 days ago

3.0.18

13 days ago

3.0.16

19 days ago

3.0.17

19 days ago

3.0.15

19 days ago

3.0.14

24 days ago

3.0.13

1 month ago

3.0.9

2 months ago

3.0.12

2 months ago

3.0.10

2 months ago

3.0.11

2 months ago

3.0.8

2 months ago

3.0.7

2 months ago

3.0.6

2 months ago

3.0.4

2 months ago

3.0.3

2 months ago

3.0.1

2 months ago

3.0.5

2 months ago

2.4.6

3 months ago

2.4.5

6 months ago

2.4.4

7 months ago

2.4.1

8 months ago

2.4.0

8 months ago

2.4.3

8 months ago

2.3.24

9 months ago

2.4.2

8 months ago

2.3.23

9 months ago

2.3.20

9 months ago

2.3.22

9 months ago

2.3.21

9 months ago

2.3.0

10 months ago

2.3.2

10 months ago

2.3.1

10 months ago

2.3.4

10 months ago

2.3.3

10 months ago

2.3.6

10 months ago

2.3.5

10 months ago

2.2.1

10 months ago

2.2.0

10 months ago

2.3.8

10 months ago

2.3.7

10 months ago

2.3.9

10 months ago

2.2.1-1

10 months ago

2.1.2

11 months ago

2.1.1

11 months ago

2.1.4

11 months ago

2.1.3

11 months ago

2.1.6

11 months ago

2.1.5

11 months ago

2.1.8

11 months ago

2.1.7

11 months ago

2.1.0

11 months ago

2.1.9

11 months ago

2.1.12

11 months ago

2.1.10

11 months ago

2.1.11

11 months ago

2.3.17

9 months ago

2.3.16

9 months ago

2.3.19

9 months ago

2.3.18

9 months ago

2.3.13

9 months ago

2.3.12

9 months ago

2.3.15

9 months ago

2.3.11

9 months ago

2.3.10

9 months ago

2.0.2-38

1 year ago

2.0.2-39

1 year ago

2.0.2-36

1 year ago

2.0.2-37

1 year ago

2.0.2-34

1 year ago

2.0.2-32

1 year ago

2.0.2-33

1 year ago

2.0.2-30

1 year ago

2.0.2-31

1 year ago

2.0.2-4

1 year ago

2.0.2-3

1 year ago

2.0.2-2

1 year ago

2.0.2-1

1 year ago

2.0.3-19

1 year ago

2.0.3-16

1 year ago

2.0.2-49

1 year ago

2.0.3-15

1 year ago

2.0.3-18

1 year ago

2.0.2-47

1 year ago

2.0.3-17

1 year ago

2.0.2-48

1 year ago

2.0.3-12

1 year ago

2.0.2-45

1 year ago

2.0.3-11

1 year ago

2.0.2-46

1 year ago

2.0.3-14

1 year ago

2.0.2-43

1 year ago

2.0.3-13

1 year ago

2.0.2-44

1 year ago

2.0.2-9

1 year ago

2.0.2-41

1 year ago

2.0.2-8

1 year ago

2.0.2-42

1 year ago

2.0.2-7

1 year ago

2.0.3-10

1 year ago

2.0.2-6

1 year ago

2.0.2-40

1 year ago

2.0.2-5

1 year ago

2.0.3-27

1 year ago

2.0.3-26

1 year ago

2.0.3-29

1 year ago

2.0.2-58

1 year ago

2.0.3-28

1 year ago

2.0.2-59

1 year ago

2.0.3-23

1 year ago

2.0.2-56

1 year ago

2.0.3-22

1 year ago

2.0.2-57

1 year ago

2.0.3-25

1 year ago

2.0.2-54

1 year ago

2.0.3-24

1 year ago

2.0.2-55

1 year ago

2.0.2-52

1 year ago

2.0.2-53

1 year ago

2.0.3-21

1 year ago

2.0.2-50

1 year ago

2.0.3-20

1 year ago

2.0.2-51

1 year ago

2.0.3-3

1 year ago

2.0.3-2

1 year ago

2.0.3-1

1 year ago

2.0.3-38

1 year ago

2.0.3-37

1 year ago

2.0.2-69

1 year ago

2.0.3-39

1 year ago

2.0.3-34

1 year ago

2.0.2-67

1 year ago

2.0.3-33

1 year ago

2.0.2-68

1 year ago

2.0.3-36

1 year ago

2.0.3-9

1 year ago

2.0.2-65

1 year ago

2.0.3-35

1 year ago

2.0.3-8

1 year ago

2.0.2-66

1 year ago

2.0.3-30

1 year ago

2.0.3-7

1 year ago

2.0.2-63

1 year ago

2.0.3-6

1 year ago

2.0.2-64

1 year ago

2.0.3-32

1 year ago

2.0.3-5

1 year ago

2.0.2-61

1 year ago

2.0.3-31

1 year ago

2.0.3-4

1 year ago

2.0.2-734

1 year ago

2.0.2-62

1 year ago

2.0.2-60

1 year ago

2.0.4-17

1 year ago

2.0.4-16

1 year ago

2.0.4-19

1 year ago

2.0.4-18

1 year ago

2.0.4-13

1 year ago

2.0.2-78

1 year ago

2.0.4-12

1 year ago

2.0.2-79

1 year ago

2.0.4-15

1 year ago

2.0.2-76

1 year ago

2.0.4-14

1 year ago

2.0.2-77

1 year ago

2.0.2-74

1 year ago

2.0.2-75

1 year ago

2.0.4-11

1 year ago

2.0.2-72

1 year ago

2.0.4-10

1 year ago

2.0.2-73

1 year ago

2.0.4-2

1 year ago

2.0.2-70

1 year ago

2.0.4-1

1 year ago

2.0.2-71

1 year ago

2.0.4-28

1 year ago

2.0.2-915

1 year ago

2.0.4-27

1 year ago

2.0.2-916

1 year ago

2.0.4-29

1 year ago

2.0.4-24

1 year ago

2.0.2-911

1 year ago

2.0.2-89

1 year ago

2.0.4-23

1 year ago

2.0.4-9

1 year ago

2.0.2-912

1 year ago

2.0.4-26

1 year ago

2.0.4-8

1 year ago

2.0.2-913

1 year ago

2.0.2-87

1 year ago

2.0.4-25

1 year ago

2.0.4-7

1 year ago

2.0.2-914

1 year ago

2.0.2-88

1 year ago

2.0.4-20

1 year ago

2.0.4-6

1 year ago

2.0.2-85

1 year ago

2.0.4-5

1 year ago

2.0.2-86

1 year ago

2.0.4-22

1 year ago

2.0.4-4

1 year ago

2.0.2-83

1 year ago

2.0.4-21

1 year ago

2.0.4-3

1 year ago

2.0.2-910

1 year ago

2.0.2-84

1 year ago

2.0.2-82

1 year ago

2.0.2-80

1 year ago

2.0.2-98

1 year ago

2.0.2-99

1 year ago

2.0.4-31

1 year ago

2.0.2-96

1 year ago

2.0.4-30

1 year ago

2.0.2-97

1 year ago

2.0.2-94

1 year ago

2.0.2-95

1 year ago

2.0.2-92

1 year ago

2.0.2-93

1 year ago

2.0.2-90

1 year ago

2.0.2-91

1 year ago

2.0.3

1 year ago

2.0.4

1 year ago

2.0.7

12 months ago

2.0.6

1 year ago

2.0.2-beta

1 year ago

2.0.2-18

1 year ago

2.0.2-19

1 year ago

2.0.2-16

1 year ago

2.0.2-17

1 year ago

2.0.2-14

1 year ago

2.0.2-15

1 year ago

2.0.2-12

1 year ago

2.0.2-13

1 year ago

2.0.2-10

1 year ago

2.0.2-11

1 year ago

2.0.2-29

1 year ago

2.0.2-27

1 year ago

2.0.2-28

1 year ago

2.0.2-25

1 year ago

2.0.2-26

1 year ago

2.0.2-23

1 year ago

2.0.2-24

1 year ago

2.0.2-21

1 year ago

2.0.2-22

1 year ago

2.0.2-20

1 year ago

1.2.0

1 year ago

2.0.2-alpha

1 year ago

1.2.8

1 year ago

1.2.7

1 year ago

1.2.6

1 year ago

1.2.5

1 year ago

1.2.4

1 year ago

1.2.3

1 year ago

1.2.2

1 year ago

1.2.1

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago

1.2.12

1 year ago

1.2.13

1 year ago

1.2.10

1 year ago

1.2.11

1 year ago

1.2.16

1 year ago

1.2.17

1 year ago

1.2.14

1 year ago

1.2.15

1 year ago

1.1.61-alpha

2 years ago

1.2.9

1 year ago

1.2.18

1 year ago

1.2.19

1 year ago

1.2.20

1 year ago

1.2.21

1 year ago

1.2.22

1 year ago

1.1.58

2 years ago

1.1.61

2 years ago

1.1.60

2 years ago

1.1.56

2 years ago

1.1.55

2 years ago

1.1.54

2 years ago

1.1.57

2 years ago

1.1.29

2 years ago

1.1.28

2 years ago

1.1.30

2 years ago

1.1.34

2 years ago

1.1.33

2 years ago

1.1.32

2 years ago

1.1.31

2 years ago

1.1.38

2 years ago

1.1.37

2 years ago

1.1.36

2 years ago

1.1.35

2 years ago

1.1.39

2 years ago

1.1.41

2 years ago

1.1.40

2 years ago

1.1.45

2 years ago

1.1.44

2 years ago

1.1.43

2 years ago

1.1.42

2 years ago

1.1.49

2 years ago

1.1.48

2 years ago

1.1.47

2 years ago

1.1.46

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.1.9

2 years ago

1.1.8

2 years ago

1.1.7

2 years ago

1.1.6

2 years ago

1.1.5

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.1.12

2 years ago

1.0.44

2 years ago

1.1.11

2 years ago

1.0.43

2 years ago

1.1.10

2 years ago

1.0.42

2 years ago

1.0.41

2 years ago

1.1.16

2 years ago

1.0.48

2 years ago

1.1.15

2 years ago

1.0.47

2 years ago

1.1.14

2 years ago

1.0.46

2 years ago

1.1.13

2 years ago

1.0.45

2 years ago

1.1.19

2 years ago

1.1.18

2 years ago

1.1.17

2 years ago

1.0.49

2 years ago

1.0.50

2 years ago

1.1.23

2 years ago

1.1.22

2 years ago

1.1.21

2 years ago

1.1.20

2 years ago

1.1.27

2 years ago

1.1.26

2 years ago

1.1.25

2 years ago

1.1.24

2 years ago

1.1.52

2 years ago

1.1.51

2 years ago

1.1.50

2 years ago

1.1.53

2 years ago

1.0.40

2 years ago

1.0.39

2 years ago

1.0.38

2 years ago

1.0.37

2 years ago

1.0.36

2 years ago

1.0.35

2 years ago

1.0.34

2 years ago

1.0.33

2 years ago

1.0.32

2 years ago

1.0.31

2 years ago

1.0.30

2 years ago

1.0.29

2 years ago

1.0.28

2 years ago

1.0.27

2 years ago

1.0.26

2 years ago

1.0.25

2 years ago

1.0.24

2 years ago

1.0.23

2 years ago

1.0.22

2 years ago

1.0.21

2 years ago

1.0.20

2 years ago

1.0.19

2 years ago

1.0.18

2 years ago

1.0.17

2 years ago

1.0.16

2 years ago

1.0.15

2 years ago

1.0.14

2 years ago

1.0.13

2 years ago

1.0.12

2 years ago

1.0.11

2 years ago

1.0.10

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago