Metadata-Version: 2.1
Name: axtbot-plugin-minecraft
Version: 1.1.0
Summary: 官方插件包之一，通过Uapis提供的接口获取用户账户信息
Author-Email: AxT-Team <axtbot@shanshui.site>
Requires-Python: >=3.11
Description-Content-Type: text/markdown

<div align="center">

# axtbot-plugin-minecraft

_✨ 官方插件包之一，通过Uapis提供的接口获取用户账户信息 ✨_


<a href="https://pypi.python.org/pypi/axtbot-plugin-minecraft">
    <img src="https://img.shields.io/pypi/v/axtbot-plugin-minecraft.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.11+-blue.svg" alt="python">

</div>

## 介绍

这是官方插件包之一，通过Uapis提供的接口获取用户账户信息

## 安装方法

<details>
<summary>使用包管理器安装</summary>
在项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

<details>
<summary>pip</summary>

    pip install axtbot-plugin-minecraft
</details>
<details>
<summary>pdm</summary>

    pdm add axtbot-plugin-minecraft
</details>
<details>
<summary>poetry</summary>

    poetry add axtbot-plugin-minecraft
</details>
</details>

<details>
<summary>使用源码安装</summary>
在项目的插件目录下，打开命令行，输入以下内容
```bash
git clone https://github.com/AxT-Team/axtbot-plugin-minecraft
```

把src中的文件夹拷贝至插件目录下

打开项目根目录下的 `pyproject.toml` 文件, 在 `[tool.axtbot]` 部分追加写入

    plugins = ["axtbot_plugin_minecraft"]

</details>


## 配置
安装完毕后，需要在 `.env` 中配置如下内容：
```bash
UAPI_KEY=uapi-xxxxxxxxxxxxxxxxxxxxxxxx
```
> [!NOTE]
> 对应的Uapi Key请在 [Uapis](https://uapis.cn/) 注册获取并生成API KEY 填入此处！

若使用 `/hyp` 则需要在 `data` 目录下新增 `config.json` 并配置：
```jsonc
{
    "hypixel": {
        "resource": "hypixel.json",          // 本地化资源文件名 (resources/ 下)
        "api_key": "你的 Hypixel API Key",    // 在 https://developer.hypixel.net 申请
        "timezone_offset": 28800             // 时间显示时区偏移(秒), 28800 = UTC+8
    },
    "staffs": ["管理员用户ID"],               // 管理员不受冷却限制
    "cooldown": 10,                          // 每用户查询冷却(秒)
    "cooldown_message": "获取速度太快了啦!"    // 冷却期间的提示
}
```

## 用法
使用 `/mc` 获取菜单

## 可选前置

- [axtbot-plugin-feedback](https://github.com/AxT-Team/axtbot-plugin-feedback)