queqiao-node-sdk
v1.0.1
Published
queqiao node sdk for manage connection with queqiao server
Readme
QUEQIAO-NODE-SDK
鹊桥SDK 现已发布正式版,主要特性如下:
- 提供完整的 TypeScript 类型支持
- 同时支持 CommonJS 和 ES6 模块版本
- 最低兼容鹊桥 MOD 版本 >= 0.4.1
如何安装:
npm install queqiao-node-sdk@latest如何自己构建:
git clone --depth 1 https://github.com/erzaozi/queqiao-node-sdk.git
npm install
npm run build如何使用(以ES6为例):
import QueQiao from 'queqiao-node-sdk';
const queqiao = new QueQiao();
queqiao.startServer(); // 可选,如果默认启动ws server
queqiao.connect({
serverName: 'server',
url: 'ws://localhost:8080/queqiao',
authorization: '114514',
}); // 作为客户端连接鹊桥服务器
// 如何调用api,仅需提供服务器名
queqiao.api.broadcast("Server", message);
queqiao.api.sendActionbar("Server", message);
queqiao.api.sendPrivateMsg("Server", message, {nickname: 'steve'});
queqiao.api.sendTitle("Server", {title: 'Hello World!'});
queqiao.api.sendRconCommand("Server", command);
// 同时,注册的事件回调包含api
const callback = (event) => {
if (event.event_type === "PlayerChatEvent") {
// 此处不需要服务器名
event.api.sendPrivateMsg({
text: "我能收到你的消息!",
type: "text"
}, {uuid: event.player.uuid});
};
};
// 注册回调并销毁
queqiao.onChat(callback).();
queqiao.onJoin(callback).();
queqiao.onDeath(callback).();
queqiao.onCommand(callback).();
queqiao.onQuit(callback).();
queqiao.onAchievement(callback).();