Advanced XRay (NeoForge 版) 技术文档

安装指南

系统要求

• 支持的操作系统：Windows, macOS, Linux
• 支持的 Minecraft 版本：1.18 及以上
• 需要安装 NeoForge 作为前置

安装步骤

1. 下载 NeoForge: 访问 NeoForge 官网 下载适用于你 Minecraft 版本的 NeoForge 安装器。
2. 安装 NeoForge: 运行下载的安装器，按照提示完成 NeoForge 的安装。
3. 下载 Advanced XRay: 访问 CurseForge 下载最新版本的 Advanced XRay 模组。
4. 安装模组: 将下载的模组文件放入 Minecraft 的 mods 文件夹中。
5. 启动游戏: 启动 Minecraft，选择 NeoForge 配置文件，进入游戏。

项目使用说明

功能概述

Advanced XRay 是一个基于 NeoForge 的 Minecraft 模组，旨在帮助玩家简化矿物搜索过程。主要功能包括：

• 使用 Forge 构建
• 简洁的用户界面，用于添加、删除和编辑 XRay 的方块
• 完整的 RGB 颜色选择器
• 可搜索的方块列表
• 从手中添加方块
• 添加你正在查看的方块
• 可搜索的已添加方块列表
• 使用 JSON 存储已添加的方块，便于编辑和分享

使用方法

1. 启用/禁用 XRay: 按下 Backslash 键切换 XRay 的 ON/OFF。
2. 打开设置界面: 按下 G 键打开 选择与设置 界面。
3. 添加方块:
   • 打开 选择与设置 界面。
   • 选择添加方块的方式：
     • 从手中：设置方块的基本版本。
     • 正在查看：设置方块的复杂版本，适用于需要特定数据的方块。
     • 搜索列表：类似于 从手中，只设置基本方块。
   • 设置名称、颜色及其他属性。
   • 点击添加并启用方块（如果未启用）。
4. 编辑方块:
   • 右键点击界面中的任意方块进行编辑。
   • 点击保存，更改将立即生效。

项目 API 使用文档

API 概述

Advanced XRay 提供了一些 API 接口，允许开发者扩展和自定义模组的功能。以下是主要的 API 接口：

1. BlockRegistry API:

   • 用于注册新的方块类型。
   • 方法：registerBlock(Block block, int color)
   • 参数：block - 要注册的方块；color - 方块的颜色。

2. ColorPicker API:

   • 用于获取和设置方块的颜色。
   • 方法：getColor(Block block)
   • 方法：setColor(Block block, int color)
   • 参数：block - 方块；color - 颜色值。

3. XRayToggle API:

   • 用于控制 XRay 的启用和禁用。
   • 方法：toggleXRay()
   • 方法：isXRayEnabled()

示例代码

// 注册新方块
BlockRegistry.registerBlock(new Block(), 0xFF0000);

// 获取方块颜色
int color = ColorPicker.getColor(block);

// 设置方块颜色
ColorPicker.setColor(block, 0x00FF00);

// 切换 XRay
XRayToggle.toggleXRay();

// 检查 XRay 状态
boolean isEnabled = XRayToggle.isXRayEnabled();

项目安装方式

手动安装

1. 下载模组文件。
2. 将模组文件放入 Minecraft 的 mods 文件夹中。
3. 启动 Minecraft，选择 NeoForge 配置文件，进入游戏。

自动安装

1. 使用 CurseForge 客户端下载并安装模组。
2. 启动 Minecraft，选择 NeoForge 配置文件，进入游戏。

通过以上步骤，你可以顺利安装并使用 Advanced XRay 模组，享受更便捷的矿物搜索体验。