Forge Mixin Example 项目教程

Forge Mixin Example 项目教程

项目地址:https://gitcode.com/gh_mirrors/fo/forge-mixin-example

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

forge-mixin-example/
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── LICENSE
├── README.md
├── settings.gradle
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── example
    │   │           └── mixin
    │   │               ├── ExampleMixin.java
    │   │               └── ExampleMod.java
    │   └── resources
    │       ├── assets
    │       │   └── examplemod
    │       │       └── logo.png
    │       ├── META-INF
    │       │   └── mods.toml
    │       └── pack.mcmeta
    └── test
        └── java
            └── com
                └── example
                    └── mixin
                        └── ExampleMixinTest.java

目录结构介绍

• build.gradle: 项目的构建脚本。
• gradle/wrapper/: Gradle Wrapper 相关文件，确保项目使用特定版本的 Gradle。
• gradle.properties: Gradle 配置属性文件。
• gradlew 和 gradlew.bat: Gradle Wrapper 脚本，用于在不同平台上执行 Gradle 任务。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• settings.gradle: Gradle 项目设置文件。
• src/: 源代码目录。
  • main/java/: 主代码目录。
    • com/example/mixin/: 包含 Mixin 和 Mod 的主要代码。
  • main/resources/: 资源文件目录。
    • assets/examplemod/: 包含 Mod 的资产文件，如 logo。
    • META-INF/mods.toml: Mod 配置文件。
    • pack.mcmeta: 资源包描述文件。
  • test/java/: 测试代码目录。

2. 项目的启动文件介绍

ExampleMod.java

package com.example.mixin;

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("examplemod")
public class ExampleMod {
    public ExampleMod() {
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::setup);
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::doClientStuff);
    }

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

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

介绍

• ExampleMod 类是项目的入口点，使用 @Mod 注解指定 Mod 的 ID。
• 在构造函数中，通过 FMLJavaModLoadingContext 注册事件监听器，处理初始化和客户端初始化事件。

3. 项目的配置文件介绍

mods.toml

modLoader="javafml"
loaderVersion="[31,)"
license="MIT"
issueTrackerURL="https://github.com/mouse0w0/forge-mixin-example/issues"

[[mods]]
modId="examplemod"
version="1.0.0"
displayName="Example Mod"
description="An example mod using Mixin."
authors="Mouse0w0"
credits="Thanks to the Forge team."
logoFile="logo.png"

介绍

• mods.toml 文件位于 src/main/resources/META-INF/ 目录下，用于配置 Mod 的元数据。
• modLoader 和 loaderVersion 指定 Mod 加载器和版本范围。
• license 指定项目许可证。
• issueTrackerURL 指定问题

forge-mixin-example An example for using Mixin in Minecraft Forge 1.12.2 & 1.8.9 项目地址: https://gitcode.com/gh_mirrors/fo/forge-mixin-example