XRay Mod 开源项目教程

XRay Mod 开源项目教程

XRay-ModMinecraft Forge based XRay mod designed to aid players who don't like the ore searching process. 项目地址:https://gitcode.com/gh_mirrors/xra/XRay-Mod

1. 项目的目录结构及介绍

目录结构

XRay-Mod/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── advancedxray/
│   │   │           └── xray/
│   │   │               ├── config/
│   │   │               ├── gui/
│   │   │               ├── network/
│   │   │               ├── util/
│   │   │               └── XRayMod.java
│   │   └── resources/
│   │       ├── assets/
│   │       │   └── xray/
│   │       │       ├── lang/
│   │       │       ├── models/
│   │       │       ├── sounds/
│   │       │       └── textures/
│   │       ├── data/
│   │       │   └── xray/
│   │       │       ├── recipes/
│   │       │       └── tags/
│   │       └── xray.toml
├── gradle/
│   └── wrapper/
├── .gitignore
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
├── LICENSE
├── README.md
└── settings.gradle

目录介绍

• src/main/java/com/advancedxray/xray/：包含项目的主要代码文件。
  • config/：配置文件相关的代码。
  • gui/：图形用户界面相关的代码。
  • network/：网络通信相关的代码。
  • util/：工具类代码。
  • XRayMod.java：项目的启动文件。
• src/main/resources/：包含项目的资源文件。
  • assets/xray/：模组资源文件，如语言文件、模型、声音和纹理。
  • data/xray/：数据文件，如配方和标签。
  • xray.toml：模组的配置文件。
• gradle/：Gradle构建工具的文件。
• .gitignore：Git忽略文件。
• build.gradle：Gradle构建脚本。
• gradle.properties：Gradle属性文件。
• gradlew 和 gradlew.bat：Gradle包装器脚本。
• LICENSE：项目许可证。
• README.md：项目说明文档。
• settings.gradle：Gradle设置文件。

2. 项目的启动文件介绍

启动文件

XRayMod.java 是项目的启动文件，位于 src/main/java/com/advancedxray/xray/ 目录下。

文件内容

package com.advancedxray.xray;

import net.minecraftforge.fml.common.Mod;
import net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent;
import net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent;
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;

@Mod("xray")
public class XRayMod {
    public XRayMod() {
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::setup);
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::doClientStuff);
    }

    private void setup(final FMLCommonSetupEvent event) {
        // 初始化代码
    }

    private void doClientStuff(final FMLClientSetupEvent event) {
        // 客户端初始化代码
    }
}

介绍

• @Mod("xray")：声明这是一个Minecraft Forge模组，模组ID为xray。
• XRayMod()：构造函数，注册事件监听器。
• setup(final FMLCommonSetupEvent event)：处理模组的通用初始化逻辑。
• doClientStuff(final FMLClientSetupEvent event)：处理模组的客户端初始化逻辑。

3. 项目的配置文件介绍

配置文件

xray.toml 是项目的配置文件，位于 src/main/resources/ 目录下。

XRay-ModMinecraft Forge based XRay mod designed to aid players who don't like the ore searching process. 项目地址:https://gitcode.com/gh_mirrors/xra/XRay-Mod