NKHI 你好,Nukkit
轻量级实用http访问接口
轻量级实用http访问接口
这是啥?能干啥?
1. NKHI是一个为nukkit系列服务器打造的http信息接口,你可以通过NKHI来在浏览器/网站上/ajax通过NKHI获取你的服务器的信息,并且支持跨域访问。
2. NKHI有许多用途,比如群机器人自动播报服内情况,在服务器官网上显示服务器状态、在线玩家等等,也可以在你的服务器宣传页里面贴上服务器状态徽标,就像这样:
(上面的图片是动态的!显示的是我的个人测试服的实时人数,虽然除了我没人进QAQ)
NKHI的特点:
- 允许跨域访问,可以用在服务器网站上
- 支持通过img.shields.io自定义服务器状态徽标
- 轻量,快速,支持任意端口
- 内置中英双语支持,自动切换
- 支持NukkitX & PowerNukkit
如何安装使用?
下载本帖附件NKHI.jar,扔进plugins文件夹,启动服务器,会在plugins文件夹里面生成NKHI文件夹,里面的config.yml是设置端口的,默认为80。
此外,你也可以通过bnpm以源码形式安装,适于有开发能力的服主。
特别提醒:Windows服务器需要在防火墙中设置指定端口的入站出站规则,教程:
首先打开控制面板里的防火墙:
点击左侧的高级设置:
选中左侧的入站规则,点击右侧的新建规则:
弹出向导,选择端口选项,然后下一步:
选择tcp和特定远程端口,输入你自己配置的端口号,如果你没有自己配置过,输入80即可,随后一路下一步就完事了。
按照相同的办法,把出站规则和入站规则都设置上就可以了。
点击左侧的高级设置:
选中左侧的入站规则,点击右侧的新建规则:
弹出向导,选择端口选项,然后下一步:
选择tcp和特定远程端口,输入你自己配置的端口号,如果你没有自己配置过,输入80即可,随后一路下一步就完事了。
按照相同的办法,把出站规则和入站规则都设置上就可以了。
返回数据示例如下:
如何自定义服务器徽章?
自定义服务器徽章是通过shields.io完成的,其实就是一个网络图片链接,具体内容可以去他们的网站看,这里提供几个示例:
https://img.shields.io/badge/dynamic/json?color=informational&label=%E6%B5%8B%E8%AF%95%E6%9C%8D&suffix=%20TPS&query=%24.tps&url=http%3A%2F%2F服务器ip或者域名%3A端口%2FNKHI&style=for-the-badge
https://img.shields.io/badge/dynamic/json?color=yellow&label=%E5%9C%A8%E7%BA%BF&suffix=%20%E7%8E%A9%E5%AE%B6&query=%24.playerNumber&url=http%3A%2F%2F服务器ip或域名%3A端口%2FNKHI&style=for-the-badge
https://img.shields.io/badge/dynamic/json?color=yellow&label=%E7%89%88%E6%9C%AC&suffix=%20%E5%9F%BA%E5%B2%A9%E7%89%88&query=%24.version&url=http%3A%2F%2F服务器ip或者域名%3A端口%2FNKHI&style=flat&logo=V
https://img.shields.io/badge/dynamic/json?color=yellow&label=MOTD&query=%24.motd&url=http%3A%2F%2F服务器ip或域名%3A端口%2FNKHI&style=flat-square&logo=Leanpub