# CraftEngineWIT-Plugin

**Repository Path**: lang5200/craft-engine-wit

## Basic Information

- **Project Name**: CraftEngineWIT-Plugin
- **Description**: CraftEngineWIT 是一款 Bukkit/Spigot 服务端附属插件，让 WIT 正确识别并展示 CraftEngine 自定义方块、家具、容器物品数量、作物生长阶段及工具需求等信息。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-14
- **Last Updated**: 2026-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CraftEngineWIT

CraftEngineWIT 是一个面向 Bukkit/Spigot 服务端的轻量附属插件，用于让 [WIT](https://github.com/darksoulq/WIT) 正确识别并展示 CraftEngine 创建的自定义方块与家具信息。

当玩家看向 CraftEngine 内容时，插件会接管 WIT 的信息栏更新，并尽可能按照玩家的客户端语言显示名称。

## 功能

- 显示 CraftEngine 自定义方块名称
- 显示 CraftEngine 自定义家具名称
- 根据玩家客户端语言解析 CraftEngine 翻译文本
- 显示自定义容器内的物品总数
- 显示作物当前生长阶段
- 提示挖掘方块所需的合适工具
- 根据手持工具是否适用切换方块名称颜色
- 支持 WIT 热重载，无需重启服务端

目前可识别以下 CraftEngine 作物行为：

- 普通作物（Crop）
- 茎类作物（Stem）
- 垂直生长作物（Vertical Crop）
- 藤蔓头部作物（Vine Crop Head）

## 环境要求

| 项目 | 当前开发版本 |
| --- | --- |
| Java | 运行 Minecraft 1.21.11 所需的 Java 版本 |
| 服务端 API | Spigot API 1.21.11 |
| CraftEngine | 26.7.4 |
| WIT | 1.9.5（项目内以本地依赖提供） |

> 上表是本项目当前编译时使用的版本。其他版本可能也能运行，但不保证 API 兼容性。

## 安装

1. 在服务端安装 CraftEngine 和 WIT。
2. 下载或自行构建 `CraftEngineWIT-1.0.jar`。
3. 将 JAR 文件放入服务端的 `plugins` 目录。
4. 启动或重启服务端。

插件声明了对 `CraftEngine` 和 `WIT` 的硬依赖；缺少任意一个依赖时，插件都无法正常启用。

## WIT 配置

CraftEngineWIT 复用 WIT 的配置与文本资源，不额外提供命令。下列 WIT 配置项会影响本插件的显示内容：

| 配置项 | 默认值 | 作用 |
| --- | --- | --- |
| `blocks.containerinfo` | `true` | 是否显示自定义容器中的物品总数 |
| `blocks.toolinfo` | `true` | 是否显示建议工具，并检测玩家手持工具是否适用 |
| `blocks.cropinfo` | `true` | 是否显示作物生长阶段 |

方块名称颜色沿用 WIT 的下列文本配置：

- `compatible_tool_color`：手持工具适用时的颜色，默认白色
- `incompatible_tool_color`：手持工具不适用时的颜色，默认灰色
- `minecraft.items_in_container`：容器物品数量的显示格式

修改 WIT 配置后，可使用 WIT 提供的重载方式使本插件重新注册处理器。

## 本地构建

项目使用 Gradle Wrapper 构建。首先确认以下文件存在：

```text
src/main/libs/WIT-1.9.5-mc.1.21.11.jar
```

然后在项目根目录执行：

### Windows

```powershell
.\gradlew.bat clean build
```

### Linux / macOS

```bash
./gradlew clean build
```

构建产物位于：

```text
build/libs/CraftEngineWIT-1.0.jar
```

## 项目结构

```text
CraftEngineWIT/
├─ src/main/java/          # 插件源代码
├─ src/main/resources/     # plugin.yml 等资源文件
├─ src/main/libs/          # WIT 本地编译依赖
├─ build.gradle            # Gradle 构建配置
└─ settings.gradle         # Gradle 项目设置
```

## 命令与权限

CraftEngineWIT 当前不注册任何命令或权限节点。插件启用后会自动接入 WIT。

## 工作原理

插件通过 WIT API 注册方块和实体处理器：

- 看向方块时，通过 CraftEngine API 获取自定义方块状态、名称、工具要求、容器数据及作物阶段。
- 看向实体时，依次识别 CraftEngine 家具的主体、碰撞箱和座位实体。
- 获取名称时，优先读取关联物品的自定义名称，其次使用 CraftEngine 翻译键，并按玩家语言、同语种语言包、英文的顺序回退。

## 反馈

如果遇到兼容性问题，请在反馈中附上以下信息：

- 服务端类型及版本
- Java 版本
- CraftEngine 版本
- WIT 版本
- CraftEngineWIT 版本
- 完整报错日志与复现步骤

项目仓库：[Gitee](https://gitee.com/lang5200/craft-engine-wit)