https://github.com/CAIMEOX/meowslib

Websocket lib for Minecraft bedrock
https://github.com/CAIMEOX/meowslib

Last synced: about 1 month ago
JSON representation

Websocket lib for Minecraft bedrock

• Host: GitHub
• URL: https://github.com/CAIMEOX/meowslib
• Owner: CAIMEOX
• License: other
• Archived: true
• Created: 2019-06-01T14:52:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-01-23T14:59:29.000Z (almost 3 years ago)
• Last Synced: 2024-11-08T03:03:41.529Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 111 KB
• Stars: 24
• Watchers: 3
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-minecraft-bedrock - Meowslib - A websocket server lib for Minecraft Bedrock Edition. (Library)

README

        
# MeoWebsocket library

## 简介

MWL是一个易于使用的Minecraft Websocket开发库


本作品采用知识共享署名-非商业性使用 4.0 国际许可协议进行许可。

## 安装

`npm install meowslib`

## 代码实例

输出玩家聊天信息:

```js

const MeoWS = require('meowslib');

const WSServer = MeoWS.WSServer;

const BuildSession = MeoWS.BuildSession;

let wss = new WSServer(23333);

wss.on('client', (session, request) => {

	console.log(request.connection.remoteAddress + ' connected!');

	session.tellraw('MeoWebsocket library v2.0.0 by CAIMEO.');

	BuildSession.createAndBind(session);

	session.on('onMessage',(msg, player)=>{

		console.log(`[${player}]Message: `, msg);

	});

});

```

事件监听器(此处订阅了BlockPlaced事件):

```js

wss.on('client', (session, request) => {

	console.log(request.connection.remoteAddress + ' connected!');

	session.tellraw('MeoWebsocket library v2.0.0 by CAIMEO.');

	BuildSession.createAndBind(session);

  	session.subscribe("BlockPlaced", (json) => {

    	console.log("BlockPlaced:", json);

  })

});

```

## API 文档

### Class MeoWS.WSServer

- `port` {Number} 服务器端口

### Class MeoWS.BuildSession

- `socket` {Session} 一般绑定WSServerSession

### Class MeoWS.Parser

命令解析器

- `command` {String} 用户命令

- `options` {Object} 规则

返回一个Object

### Events

#### onMessage

当玩家发送消息时触发，传入信息内容(message)和发送者(Sender)

#### onJSON

当玩家发送消息时触发，不同的是，它将传回json

#### onError

发生错误时触发,传回错误信息

#### onCommand

党玩家发送消息并被Parser解析完成时触发，传回object

### Session

#### sendCommand(command, callback)

向客户端发送命令

- command {String} 命令

- callback {Function} 回调函数，传入json

#### sendCommandSync(command)

向客户端发送命令(Promise)

- command {String} 命令

#### subscribe(event,callback)

订阅游戏事件

- event {String} 游戏事件

- callback {String}回调函数，传入json

#### unsubscribe(event)

取消订阅游戏事件

- event {String} 游戏事件

#### sendText(text)

发送信息

- text {String} 要发送的消息

#### tellraw(text, color)

tellraw代码

- text {String} 要发送的消息

- color {String} 颜色代码