🤖NIAHttpBOT

大约 15 分钟

🤖NIAHttpBOT

版本提示

以下所有api均基于最新构建的版本（见下方RELEASE）

NiaServer-Core

简介

使用C++开发的BOT，基于http实现更多可能，本项目为NiaServer-Core子项目

为什么开发？

由于目前我的世界的Script-api无法实现诸如文件读写等功能,为此我们特此基于C++开发了NIAHttpBOT用来实现更多功能，从而赋予Script-api更多可能

功能特性

基于http可以实现对特定文件进行读写、创建以及删除等功能
基于http搭配NiaServer-Core以及NapCatQQ可以实现QQ机器人与服务器联动功能

项目优势

轻量级设计，内存占用低
即开即用，无需复杂环境配置
跨平台兼容
不受Minecraft BDS版本更新的影响

使用前注意事项

本项目基于http进行通讯，故当前Minecraft版本应当注意启用minecraft/server-net模块（该模块只能运行在服务器上）
您可以前往NIAHttpBOT项目地址的release下载最新release构建的NIAHttpBOT.exe来获取最新版的NIAHttpBOT
如果您在使用期间遇到了问题/有建议，您可以前往NIAHttpBOT的issues进行反馈！
由于采用的是http通讯，而非https，我们非常不推荐您将NIAHttpBOT与基岩版服务端分开放置于两台服务器上，这是非常不安全的操作！请务必将NiaHttpBOT与基岩版服务端放置于同一台服务器之上，并注意防火墙设置，不要开放使用过程中涉及的两个端口，以免对服务器安全造成威胁！

使用教程

Windows平台

提示

不使用QQ机器人的用户可以跳过第5-9步

前往我的世界官网下载BDS，并将下好的服务端解压
安装好对应的行为包
修改服务器端文件，来启用net模块：将config/default/permissions.json内容改为

{
    "allowed_modules": [
        "@minecraft/server-gametest",
        "@minecraft/server",
        "@minecraft/server-ui",
        "@minecraft/server-admin",
        "@minecraft/server-editor",
        "@minecraft/server-net"
    ]
}

Windows平台下下载最新release构建的NIAHttpBOT.exe来获取最新版的NIAHttpBOT
根据NapCatQQ安装教程安装相应的机器人框架
安装后，打开机器人WEBUI界面，点击侧边栏网络配置，点击添加配置
名称首先写上服务器，类型选择http服务器，启用，并将端口与NIAHttpBOT的配置文件中的ClientPort保持一致；
然后再次点击添加配置，名称写上客户端，类型选择http客户端，启用，并将URL一栏与NIAHttpBOT中配置文件的http://127.0.0.1:<ServerPort>/<Locate>保持一致，如果是原始配置文件没有改动，则为http://127.0.0.1:10086/qqEvent，机器人至此配置完毕。
按照NapCatQQ安装教程中指示启动机器人
双击NIAHttpBOT.exe来启动，第一次启动时会生成配置文件，配置文件路径为./NIAHttpBOT.cfg，您可以根据自己的需求进行修改，具体修改教程见配置文件，修改后请输入reload来重新加载配置文件。
最后启动MCBDS服务端即可！

Linux平台

提示

不使用QQ机器人的用户可以跳过第5-9步

前往我的世界官网下载BDS，并将下好的服务端解压
安装好对应的行为包
修改服务器端文件，来启用net模块：将config/default/permissions.json内容改为

{
    "allowed_modules": [
        "@minecraft/server-gametest",
        "@minecraft/server",
        "@minecraft/server-ui",
        "@minecraft/server-admin",
        "@minecraft/server-editor",
        "@minecraft/server-net"
    ]
}

Linux平台下载最新release构建的NIAHttpBOT来获取最新版的NIAHttpBOT
根据NapCatQQ安装教程安装相应的机器人框架
安装后，打开机器人WEBUI界面，点击侧边栏网络配置，点击添加配置
名称首先写上服务器，类型选择http服务器，启用，并将端口与NIAHttpBOT的配置文件中的ClientPort保持一致；
然后再次点击添加配置，名称写上客户端，类型选择http客户端，启用，并将URL一栏与NIAHttpBOT中配置文件的http://127.0.0.1:<ServerPort>/<Locate>保持一致，如果是原始配置文件没有改动，则为http://127.0.0.1:10086/qqEvent，机器人至此配置完毕。
按照NapCatQQ安装教程中指示启动机器人
在终端输入./NIAHttpBOT来启动NIAhttpBOT

提示

在Linux如果出项权限不够的提示，这个错误是因为你试图运行的文件没有执行权限。你可以使用 chmod 命令来给文件添加执行权限。以下是具体的步骤（11-13）：

打开终端
使用 cd 命令导航到文件所在的目录
运行 chmod +x NIAHttpBOT 命令给文件添加执行权限

然后你就可以使用 ./NIAHttpBOT 命令来运行你的程序了，第一次启动时会生成配置文件，配置文件路径为./NIAHttpBOT.cfg，您可以根据自己的需求进行修改，具体修改教程见配置文件，修改后请输入reload来重新加载配置文件。

最后启动MCBDS服务端即可！

开发注意事项

我们是基于NapCatQQ开发的QQ机器人
由于minecraft/server-net模块在本地存档中无法启用，所以我们应当在本地搭建一个如上述教程服务器环境用于开发
在本地开发时,我们应当解除loopback，否则我们无法在游戏中通过127.0.0.1进入游戏，具体操作步骤如下：

以管理员身份打开PowerShell，然后根据MC版本输入以下命令：

Minecraft Bedrock Edition（正式版）

CheckNetIsolation.exe LoopbackExempt -a -p=S-1-15-2-1958404141-86561845-1752920682-3514627264-368642714-62675701-733520436

Minecraft Bedrock Edition Preview（预览版）

CheckNetIsolation.exe LoopbackExempt -a -p=S-1-15-2-424268864-5579737-879501358-346833251-474568803-887069379-4040235476

配置文件

# 语言文件路径,默认为空-CN
LanguageFile = ""

# ip地址，一般为不用改
IPAddress = "127.0.0.1"

# 服务器端口，需与行为包端口以及QQ机器人作为客户端上报事件地址保持一致
ServerPort = 10086

# 功能配置:

#是否启用DOS指令功能
UseCmd = false

# QQ机器人配置:

# 是否启用QQ机器人,默认为true
UseQQBot = true

# 客户端端口，需要与QQ机器人作为服务器设置的监听Http端口一致
ClientPort = 10023

# 不知道啥作用的不用改
Locate = "/qqEvent"

# 主人QQ配置
OwnerQQ = "123456789"

# 监听QQ群
QQGroup = "123456789"

QQ-BOT 相关指令

一般指令

参数说明

<XboxID> 玩家的XboxID

注：当前还不能录入带空格的XboxID,需要管理员手动修改player_data.json文件

详细指令

#帮助: 显示帮助菜单

#赞我: 给自己点10个赞

#绑定 <XboxID>: 绑定XboxID

例：#绑定 NIANIANKNIA

#查：查询自己账号的相关信息

#查 @要查询的人 : 查询别人账号的相关信息

管理指令

参数说明

<时间> 应当以min(分钟)、h(小时)、d(天)为结尾，前面只能为阿拉伯数字

例：1min、10h、100d等

详细指令


#禁言 @要禁言的人 <时间>: 禁言指定群成员

例：#禁言 @NIANIANKNIA 1h

#解禁 @要解禁的人: 解禁指定群成员

#改绑 @要改绑的人 <XboxID>: 改绑XboxID

#封禁 @要封禁的人 <时间>: 封禁指定群成员游戏账号

例：#封禁 @NIANIANKNIA 1d

#解封 @要解封的人: 解封指定群成员账号

#改权限 @要改权限的人 <权限>: 改变指定群成员的权限

HTTP API一览表

v1.0

Http API	方法	简介	Windows	Linux
/RunCmd	POST	执行DOS指令	✅	✅
/CheckFile	POST	检查文件是否存在	✅	✅
/CheckDir	POST	检查文件夹是否存在	✅	✅
/CreateNewFile	POST	创建一个文件	✅	✅
/CreateNewJsonFile	POST	创建一个JSON文件	✅	✅
/GetFileData	POST	获取文件数据	✅	✅
/GetJsonFileData	POST	获取JSON文件数据	✅	✅
/OverwriteFile	POST	覆写文件内容	✅	✅
/OverwriteJsonFile	POST	覆写JSON文件内容	✅	✅
/WriteLineToFile	POST	向文件写入一行内容	✅	✅

POST方法 API使用方法

向http://<IPAddress>:<ClientPort>发送一个http POST请求

请求体内容应为json格式：

{
    "api_version": "1.0", // API版本号
    "key_1": "value_1", // 传入的参数1
    "key_2": "value_2" // 传入的参数2（可选）
    // ...
}

NIAHttpBOT若收到请求则会返回状态码200且根据请求内容返回如下json格式：

{
    "httpbot_version": "1.1", // NIAHttpBOT版本号
    "status": "success", // 状态码，若请求处理成功则为success，否则为fail
    "data": { // 返回的数据
        "key_1": "value_1", // 返回的参数1
        "key_2": "value_2" // 返回的参数2（可选）
        // ...
    },
    "failure_code": 100, // 若请求处理失败则返回失败代码
}

错误码列表

错误码	错误原因
100	请求体格式错误
101	请求体缺少必要的键
102	请求体键的值格式错误
200	API版本不匹配
300	NIAhttpBOT自身错误
400	目标操作文件/路径不存在
401	目标操作文件已经存在无法创建
500	没有成功链接到qq机器人
501	目标qq群不存在
502	qq群消息发送失败

[POST] `/RunCmd`

执行DOS命令

[!warning] 由于API涉及服务器安全性问题，本功能默认关闭，请在确定做好准备的条件下修改配置文件后启用本功能！

可以实现的功能：

如需了解更多DOS指令，请前往微软官方文档站查看

参数

字段名	数据类型	默认值	说明
`api_version`	string		API版本
`cmd`	string		要执行的dos指令，如del 123.txt

响应数据

无

[POST] `/CheckFile`

检查一个文件是否存在

参数

字段名	数据类型	默认值	说明
`api_version`	string		API版本
`file_name`	string		要检查的目标文件名字

响应数据

字段名	数据类型	说明
`result`	bool	文件存在为true，不存在为false

[POST] `/CheckDir`

检查目标文件夹是否存在

参数

字段名	数据类型	默认值	说明
`api_version`	string		API版本
`dir_name`	string		要检查的目标文件夹名字

响应数据

字段名	数据类型	说明
`result`	bool	文件夹存在为true，不存在为false

[POST] `/CreateNewFile`

创建一个文件并写入内容

参数

字段名	数据类型	说明
`api_version`	string	API版本
`file_name`	string	要创建的目标文件名字
`content`	string	要写入的内容

响应数据

无

[POST] `/CreateNewJsonFile`

创建一个JSON文件并写入内容

参数

字段名	数据类型	说明
`api_version`	string	API版本
`file_name`	string	要创建的目标JSON文件名字
`content`	object	要写入的内容，必须为JSON格式

响应数据

无

[POST] `/GetFileData`

获取文件数据

参数

字段名	数据类型	默认值	说明
`api_version`	string		API版本
`file_name`	string		要获取的目标文件名字

响应数据

字段名	数据类型	说明
`file_data`	string	获取成功则返回文件内容

[POST] `/GetJsonFileData`

json文件应当没有任何语法错误/注释，否则将无法正确读取json数据！详细请查看json文件读取注意事项

获取JSON文件数据

参数

字段名	数据类型	默认值	说明
`api_version`	string		API版本
`file_name`	string		要获取的目标JSON文件名字

响应数据

字段名	数据类型	说明
`file_data`	object	获取成功则返回JSON内容

[POST] `/OverwriteFile`

覆盖文件内容

参数

字段名	数据类型	说明
`api_version`	string	API版本
`file_name`	string	要覆盖的目标文件名字
`content`	string	要覆盖的内容

响应数据

无

[POST] `/OverwriteJsonFile`

覆盖JSON文件内容

参数

字段名	数据类型	说明
`api_version`	string	API版本
`file_name`	string	要覆盖的目标JSON文件名字
`content`	object	要覆盖的内容，必须为JSON格式

响应数据

无

[POST] `/WriteLineToFile`

向目标文件最后写入如一行内容

注意增加换行符（\n），否则不会换行！

参数

字段名	数据类型	说明
`api_version`	string	API版本
`file_name`	string	要写入的目标文件名字
`content`	string	要写入的内容

响应数据

无

[POST] `/SendQQGroupMessage`

向指定QQ群发送消息

参数

字段名	数据类型	说明
`api_version`	string	API版本
`group_id`	string	要发送消息的QQ群号
`message`	string	要发送的消息内容

响应数据

无

附加说明

JSON文件读取注意事项

json文件应当没有任何语法错误/注释，否则将无法正确读取json数据！

以下是错误示例：

多了一个,产生了语法错误！

{
    "key":value,
}

不能进行注释，否则会导致无法正确读取！

{
    //这是一行注释，这会导致无法正常读取！
    "key":value
}

错误的使用了中文的标点符号导致语法错误！

{
    "key1":value，
    "key2"：value
}

使用示例

建议使用的方法

创建./API/filesystem.js文件，内容如下

(目前写了一些常用的功能，更多功能将在后续更新)

点击下载示例文件

import {http,HttpRequestMethod,HttpRequest,HttpHeader} from '@minecraft/server-net';

const port = 10086
const server_url = "http://127.0.0.1"

export class ExternalFS {

    /**
     * @function 执行DOS命令
     * @param {String} cmd
     * @return {String | Number} 获取成功返回success，服务器连接失败返回-1
     */
    RunCmd(cmd) {
        const reqRunCmd = new HttpRequest(`${server_url}:${port}/RunCmd`)
        .setBody(cmd)
        .setMethod(HttpRequestMethod.Post)
        .addHeader("Content-Type", "text/plain");
        return new Promise(async (resolve) => {
            const response = await http.request(reqRunCmd);
            if (response.status == 200) {
                resolve(response.body);
            } else {
                resolve(-1);
            }
        })
    }

    /**
     * @function 获取文件内容
     * @param {String} filename
     * @return {String | Number} 获取成功返回文件数据，文件不存在返回0，服务器连接失败返回-1
     */
    GetFileData(filename) {
        const reqGetFileData = new HttpRequest(`${server_url}:${port}/GetFileData`)
        .setBody(filename)
        .setMethod(HttpRequestMethod.Post)
        .addHeader("Content-Type", "text/plain");
        return new Promise(async (resolve) => {
            const response = await http.request(reqGetFileData);
            if (response.status == 200) {
                resolve(JSON.parse(response.body));
            } else if (response.status == 400) {
                resolve(0);
            } else {
                resolve(-1);
            }
        })
    }

    /**
     * @function 获取json文件内容
     * @param {String} filename
     * @return {Object | Number} 获取成功返回json数据，文件不存在返回0，服务器连接失败返回-1
     */
    GetJSONFileData(filename) {
        const reqGetJsonFileData = new HttpRequest(`${server_url}:${port}/GetJsonFileData`)
        .setBody(filename)
        .setMethod(HttpRequestMethod.Post)
        .addHeader("Content-Type", "text/plain");
        return new Promise(async (resolve) => {
            const response = await http.request(reqGetJsonFileData);
            if (response.status == 200) {
                resolve(JSON.parse(response.body));
            } else if (response.status == 400) {
                resolve(0);
            } else {
                resolve(-1);
            }
        })
    }

    /**
     * @function 创建新文件
     * @param {String} filename
     * @param {String} filecontent
     * @return {String | Number} 创建成功返回success，创建失败返回0，服务器连接失败返回-1
     */
    CreateNewFile(filename,filecontent) {
        const reqCreateNewFile = new HttpRequest(`${server_url}:${port}/CreateNewFile`)
        .setBody(JSON.stringify({"fileName":filename,"content":filecontent}))
        .setMethod(HttpRequestMethod.Post)
        .addHeader("Content-Type", "text/plain")
        return new Promise(async (resolve) => {
            const response = await http.request(reqCreateNewFile);
            if (response.status == 200) {
                resolve(response.body);
            } else if (response.status == 400) {
                resolve(0);
            } else {
                resolve(-1);
            }
        });
    }

    /**
     * @function 创建json文件
     * @param {String} filename
     * @param {Object} filecontent
     * @return {String | Number} 创建成功返回success，创建失败返回0，服务器连接失败返回-1
     */
    CreateNewJsonFile(filename,filecontent) {
        const reqCreateNewJsonFile = new HttpRequest(`${server_url}:${port}/CreateNewJsonFile`)
        .setBody(JSON.stringify({"fileName":filename,"content":filecontent}))
        .setMethod(HttpRequestMethod.Post)
        .addHeader("Content-Type", "text/plain")
        return new Promise(async (resolve) => {
            const response = await http.request(reqCreateNewJsonFile);
            if (response.status == 200) {
                resolve(response.body);
            } else if (response.status == 400) {
                resolve(0);
            } else {
                resolve(-1);
            }
        });
    }

    /**
     * @function 覆写文件
     * @param {String} filename
     * @param {String} filecontent
     * @return {String | Number} 覆写成功返回success，覆写失败返回0，服务器连接失败返回-1
     */
    OverwriteFile(filename,filecontent) {
        const reqOverwriteFile = new HttpRequest(`${server_url}:${port}/OverwriteFile`)
        .setBody(JSON.stringify({"fileName":filename,"content":filecontent}))
        .setMethod(HttpRequestMethod.Post)
        .addHeader("Content-Type", "text/plain");
        return new Promise(async (resolve) => {
            const response = await http.request(reqOverwriteFile);
            if (response.status == 200) {
                resolve(response.body);
            } else if (response.status == 400) {
                resolve(0);
            } else {
                resolve(-1);
            }
        })
    }

    /**
     * @function 覆写json文件
     * @param {String} filename
     * @param {Object} filecontent
     * @return {String | Number} 覆写成功返回success，覆写失败返回0，服务器连接失败返回-1
     */
    OverwriteJsonFile(filename,filecontent) {
        const reqOverwriteJsonFile = new HttpRequest(`${server_url}:${port}/OverwriteJsonFile`)
        .setBody(JSON.stringify({"fileName":filename,"content":filecontent}))
        .setMethod(HttpRequestMethod.Post)
        .addHeader("Content-Type", "text/plain");
        return new Promise(async (resolve) => {
            const response = await http.request(reqOverwriteJsonFile);
            if (response.status == 200) {
                resolve(response.body);
            } else if (response.status == 400) {
                resolve(0);
            } else {
                resolve(-1);
            }
        })
    }

    /**
     * @function 向特定文件写入一行内容
     * @param {String} filename
     * @param {String} filecontent
     * @return {String | Number} 写入成功返回success，覆写失败返回0，服务器连接失败返回-1
     */
    WriteLineToFile(filename,filecontent) {
        const reqWriteLineToFile = new HttpRequest(`${server_url}:${port}/WriteLineToFile`)
        .setBody(JSON.stringify({"fileName":filename,"content":filecontent}))
        .setMethod(HttpRequestMethod.Post)
        .addHeader("Content-Type", "text/plain");
        return new Promise(async (resolve) => {
            const response = await http.request(reqWriteLineToFile);
            if (response.status == 200) {
                resolve(response.body);
            } else if (response.status == 400) {
                resolve(0);
            } else {
                resolve(-1);
            }
        })
    }
}

然后我们可以直接调用即可，不用反复写

调用示例(截取自玩家交易市场部分代码)

import { world } from '@minecraft/server';
import { ExternalFS } from './API/filesystem';

//违禁物品，等后期接入配置文件
const fs = new ExternalFS();
const port = 10086
var MarketData = [-1]


//服务器启动监听&&获得玩家市场数据
world.afterEvents.worldInitialize.subscribe(() => {
    fs.getJSONFileData("market.json").then((result) => {
        //文件不存在
        if (result === 0) {
            fs.CreateNewJsonFile("market.json",[]).then((result) => {
                if (result === "success") {
                    MarketData = [];
                    console.log("玩家市场文件不存在，已成功创建！");
                } else if (result === -1) {
                    console.error("依赖服务器连接失败！请检查依赖服务器是否成功启动，以及端口是否设置正确！");
                }
            });
        } else if (result === -1) {
            console.error("依赖服务器连接失败！请检查依赖服务器是否成功启动，以及端口是否设置正确！");
        } else {
            //文件存在且服务器连接成功
            MarketData = result;
            console.log("玩家市场数据获取成功！")
        }
    })
})

实际应用

玩家交易市场

第三方开源引用

rapidjson - MIT License

cpp-httplib - MIT License

OBJ-Loader - MIT License

许可证

本项目基于AGPL-3.0开源许可证条款