跳到主要内容

摘要

是什么?

ov0是基于事件驱动的移动端应用扩展框架,提供了标准的事件发布和订阅接口,主要用于聊天平台机器人的自动化程序集成,开发者可使用typescript或javascript编写扩展插件实现向聊天平台机器人发布多种类型的消息。

插件开发

在正式编写插件之前,我们需要准备插件的开发环境,你需要了解一些js相关的知识,并对node(一个应用程序)环境有一定的概念。 如果你是前端开发人员,那么ov0将很适合作为你开发移动端bot应用的框架。对于普通的插件来说,我们只需要node就足够了。

设备要求

一部手机(目前仅支持android)、一台电脑、手机和电脑要在同一局域网内 pass: 有wifi则让手机和电脑连接同一wifi,没wifi则让电脑连接手机热点

安装node

为了方便管理node版本,推荐使用nvm来安装node。

打开cmd或其他命令行工具,直接输入以下脚本:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash

等待下载完成后输入以下命令验证nvm是否安装成功:

nvm --version

如果正常出现版本号,则可开始安装node,这里用最新版即可:

nvm install node

等待安装完成后关掉并重新打开命令行窗口,并输入以下命令验证node是否安装成功:

node -v

如果正常打印版本号则说明node安装完成,我们即可进行后面步骤。

下载ov0插件开发模板

进入一个干净的目录打开你的命令行窗口,注意该路径不要出现中文,然后输入以下命令回车:

npm create ov0@latest

根据提示创建开发模板,将生成以下目录结构示例(可能因版本变动不同,请以最新版本生成的目录为准):

├─ src # 源码
│ └─index.js # 入口文件
├─ web # 源码
| ├──index.html # 入口文件
├─ public # 公共资源文件
| └─logo.png
├─ README.md
└─ package.json

进入到你项目目录:

cd ov0-plugin-example

安装依赖:

yarn install

打开src/index.js,写下以下代码:

import { logger } from 'ov0'
logger.info('hello world!')

此时你完成了最简单的插件,编译发布后你可以在app安装终端模拟插件查看你的插件运行效果,后面会介绍如何编译并发布你的插件到插件市场。

如何验证它是否能运行

我们强烈建议您使用vscode,打开项目并根据界面提示安装vscode扩展插件,它对typescript有着天然支持,安装完成后,如果你的代码编辑界面没有报红,那么它大概率可以正常运行。