跳到正文

Omi’s API

作者:Omi036

Omi's API is a server-sided mod that includes a configurable API for developers to interact with.

收藏

截图

介绍

中文介绍正在准备中,下面暂时显示原文。

 

Omi's_Api_banner

 Omi’s Minecraft API is a server-side mod which creates a simple API to connect with.

 
Getting Started

  • Download the mod and place it on your server.
  • When starting the server, the mod will boot up and the config file should show up in the config folder.
  • Modify the omiapi-common.toml file as you like.
  • Be sure to change the auth settings to avoid third-party connections
  • Restart the server
  • If when first sending a request to the server, you notice an error in the server console, just ignore it.

About the API

The API allows server admins to connect and interact remotely while maintaining a simple and secure style. This tool will come in handy while working with integrations or webhooks.

Currently, the API supports:

  • Retrieving the general status of the server
  • Retrieving detailed information about the server (players, config, memory…)
  • Retrieving the player list
  • Retrieving a player’s inventory
  • Retrieving the Ban List
  • Broadcasting a Minecraft-formatted message
  • Whispering to a user
  • Executing a command
  • Shutdown the server
  • Kick a player
  • Ban a player (Both via IP and GameProfile/UUID)
  • Unbanning a player (IP or GameProfile/UUID)

Moreover, the API not only uses Basic Auth to ensure security but it can also be configured to disable routes you may not use. 

You can see the routes documentation here.

 

常见问题

Omi’s API 支持哪些 Minecraft 版本?

Omi’s API 支持 Minecraft Java 版 1.19.2,可用的加载器:Forge。下载时注意选择和你游戏版本一致的文件。

Omi’s API 怎么安装?

先用 PCL2 或 HMCL 启动器安装对应版本的 Forge,再把下载的 .jar 文件放进游戏目录的 mods 文件夹,重新启动游戏即可。开启了版本隔离的,mods 文件夹在 versions/版本名 下面。

评论

登录后评论和评分

Omi036 的其他作品

查看全部 →