Lode.Api（Bukkit 版本）

写在前面

此版本为 Lode.Api 的 Bukkit 版本，如果需要查看 Nukkit 分支，请点击这里。

简介

Lode.Api 是一个用于 Nukkit/Bukkit(like)⁽¹⁾ 服务器的插件。提供了访问服务器各种数据和功能的 Http 和 WebSocket 接口。你可以通过这些接口来制作网站、App，以及提供让玩家在线购买物品并且在游戏中自动接收相关物品的能力⁽²⁾。

⁽¹⁾：Bukkit Like - 基于 Bukkit 或 Bukkit 相兼容的服务端，譬如 Spigot、Paper 等。

⁽²⁾：Lode.Api 并不提供上述服务，您可以根据 Lode.Api 提供的 API 自行实现相关的功能。

重要说明

Lode.Api 还处于早期的开发中状态。Lode.Api 的目录结构、API 地址、配置文件格式等均有可能在未来发生变化。不建议将当前版本的插件用于重要的线上服务器中。

插件说明

Lode.Api 提供了使用 Http 调用 Nukkit/Bukkit(like) 底层功能的能力，可以实现大部分包括服务器管理、插件管理、用户管理等方面的功能。您可以在 Nukkit/Bukkit(like) 服务器安装有 Lode.Api 的前提下，使用 Http 和 WebSocket 接口开发相关网站、App、商城系统等。也可以以 Lode.Api 提供的 API 为基础，开发类似“云插件”（开发中）的功能（不限编程语言，无需安装至服务器）。

API 相关信息

API 文档

请至 Lode.Api 的 Wiki 页面查阅相关说明和 API 文档。

调用方式

所有 API 均使用 POST 方式调用。

调用参数

所有 API 的的调用参数（JSON 格式）请放置于请求的 Body 中。

API 鉴权

为了 API 调用安全，请将鉴权信息放置于请求 Header 的 X-Lode-Authentication 中，鉴权信息的格式为：

token={token}; ts={timestamp}

其中，token 的生成方式为：

sha256(userName + api_url.toLowerCase() + password)

例如在配置文件（将在下文介绍）中设置的 UserName 为 exampleUser，Password 为 testpass，需要调用的 API 地址为 /api/Server/GetServerInfo ，则鉴权信息为：

sha256( "exampleuser/api/server/getserverInfotestpass" )

ts 为 UNIX 时间戳（毫秒），Lode.Api 将对此参数和服务器当前时间进行比较，若时间相差大于等于 2 分钟，则会拒绝这次请求并返回 403 Forbidden 信息。

一个完整的例子：

X-Lode-Authentication： token=1ddc6a51b3326a88a6ff301e3ac1b588050a5d5b2ba09540d54254ae2ed7147e; ts=1554805018000

配置文件

Lode.Api 的配置文件位于服务器的 plugins/Lode 文件夹下，初次启动插件会自动生成配置文件，您可以根据需要自行修改。配置文件的格式如下：

Server:
  IP: 0.0.0.0
  Authentication:
    Password: password
    UserName: root
  HttpPort: 19133
  WsPort: 19134

EventListener:
  IsEnable: true
  ServerConsole: true
  OtherEvents: true
  ExecuteByWs: true
  EventList:
    - ServerCommand
    - PlayerChat

DebugMode: true

配置文件说明

Server.Authentication 是 API 鉴权所需要的用户名和密码。
Server.IP 是配置 WebSocket 服务器监听的 IP 地址。
Server.HttpPort 是 API 服务器监听的端口，请不要与游戏服务端本身的端口冲突。
Server.WsPort 是 W1ebSocket 服务器监听的端口，请不要与游戏服务端本身的端口冲突。
EventListener.IsEnable 配置事件通知的 WebSocket 服务是否启用。
EventListener.ServerConsole 配置是否通过 WebSocket 发送服务器实时输出。
EventListener.OtherEvents 配置是否监听除了服务器实时输出外的其他 Lode.Api 事件。
EventListener.ExecuteByWs 配置是否可以通过 WebSocket 执行命令。
EventListener.EventList 如果 EventListener.OtherEvents 为 true ，则这个列表下的事件会被 Lode.Api 监听，并且通过 WebSocket 发送实时通知。
DebugMode 配置是否启动 Debug 模式，若为 true 则会在控制台输出调试信息并且调用 API 时无需鉴权信息。

下载

你可以查阅 release 页面并下载最新的构建。

开发相关

插件版本

Lode.Api 分别提供 Nukkit(X) 和 Bukkit(like) 两个版本，根据各自服务端的代码实现略有不同，但是尽量保持了两个版本间一致的 API 调用和返回值类型。你可以分别查看两个版本的代码：

版本优先级

因开发者精力有限，Lode.Api 在代码层面以 Nukkit(X) 版本优先开发，随后将更新 Bukkit(like) 版本的代码。

但是发布 release 版本时，将尽可能保证 Nukkit(X) 版本和 Bukkit(like) 版本一同发布，确保有相同的体验。

开发和发布流程

Lode.Api 所有新功能的开发都会在新的 feature 分支进行开发，并且经过测试验证后合并到 develop 分支中。最终在发布时，develop 分支的代码会合并到对应版本的 master 分支。

已知问题

暂无。欢迎体验并发现问题后提出 Issue。

更新日志

本项目遵从 Angular Style Commit Message Conventions，更新日志由 conventional-changelog 自动生成。完整日志请点击 CHANGELOG.md。

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Tuisku-L / Lode.Api.Bukkit