Skip to content

Latest commit

 

History

History
131 lines (100 loc) · 4.57 KB

README_en.md

File metadata and controls

131 lines (100 loc) · 4.57 KB
Raw
NoneBotPluginLogo

nonebot-plugin-mccheck

✨ Minecraft Server Query Plug-in

license pypi python pypi-download-count

English|简体中文

📖 Introduction

Minecraft server status query, supporting IPv6.

update synchronously with https://github.com/molanp/zhenxun_check_minecraft/.

💿 Installation

One of the methods mentioned below can be selected.

[recommended] install using nb-cli Open the command line in the root directory of Bot and enter the following instructions to install. 
nb plugin install nonebot-plugin-mccheck
install using package manager In the plug-in directory of the nonebot2 project, open the command line and enter the corresponding installation command according to the package manager you use. 
pip install nonebot-plugin-mccheck
# or
pdm add nonebot-plugin-mccheck
# or
poetry add nonebot-plugin-mccheck
# or
conda install nonebot-plugin-mccheck

Open the pyproject.toml file in the root directory of the nonebot2 project, and write in the [tool.nonebot] section.

plugins = ["nonebot_plugin_mccheck"]

📈 Implemented functions

  • Full platform adapter support
  • Adapted unicode full fonts and glyphs
  • Render Motd styles
  • Query server nickname
  • Query the maximum number of servers, the current number of people
  • Query server motd
  • returns the server address and port
  • Returns the server online status
  • Query server latency
  • More precise delay
  • UDP server is supported
  • Error message feedback
  • Port autocompletion
  • WisdomBarrier can determine whether the IP address is correct
  • Get the JSON version of the server motd (only if the server motd is set to JSON format)
  • Does not depend on any external API :)
  • Support special port queries (e.g. 2, 80, 443 etc.)
  • Query server favicon
  • Multilingual
  • SRV support
  • Fully colored underlined/strikethrough

📑 Future functions

  • Get server protocol number
  • Get server official website (if any)
  • And more...

🖼️ Test screenshot

v0.1.22

Text message 0.1.22 text

Picture message 0.1.22 pic

HTML message 0.1.22 html

Geyser server double check(More than just HTML messages are supported, only one is shown here) 0.1.22 geyser

⚙️ Configuration

Add the required configuration in the following table to the .env file of the nonebot2 project.

Configuration Item Required Default Value Description
MCC__LANGUAGE False zh-cn Languages used by the plugin to render images
Available languages: [zh-cn,zh-tw,en]
MCC__TYPE False 0 The type of message the plugin sends (0 for HTML, 1 for image, 2 for text)

🎲 Comparison of message types

Type Special Styles Favicon Fully colored underline/strikethrough Full Unicode font support
Text ❌ ⭕ ❌ ⭕
Picture ⭕ ⭕ ⭕ ❌
HTML ⭕ ⭕ ⭕ ⭕

🎉 Usage

Command Parameter Scope Description
mcheck [ip]:[port] or [ip] Private/Group Chat Check Minecraft server status
set_lang Language name Private/Group Chat Set the language used by the plugin for rendering images
lang_now None Private/Group Chat View the current language used by the plugin for rendering images
lang_list None Private/Group Chat View the list of languages supported by the plugin