# jar-mod-example-plus

**Repository Path**: zqll4/jar-mod-example-plus

## Basic Information

- **Project Name**: jar-mod-example-plus
- **Description**: 本项目为基于libgdx和artemis的游戏的 Mod 开发平台示例，功能进行了大幅增强
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-20
- **Last Updated**: 2025-11-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

本项目为一个游戏的 Mod 开发平台，包含两个主要模块：

- **core**：核心模块，提供游戏运行的基础功能和 Mod 加载支持。
- **mod-api**：Mod 开发接口模块，开发者可基于此模块编写自定义 Mod。

## 目录结构

```
game-mod/
├── core/         # 核心模块
│   ├── src/
│   ├── build.gradle
│   └── ...
├── mod-api/      # Mod API 模块
│   ├── src/
│   ├── build.gradle
│   └── ...
└── ...
```

---

## Mod 开发流程

1. **环境准备**
    - 安装 JDK（推荐 17 及以上版本）。
    - 安装 Gradle（或使用项目自带的 Gradle Wrapper）。

2. **创建 Mod 项目**
    - 以 `mod-api` 为依赖，创建新的 Mod 项目。
    - 在 `build.gradle` 中添加依赖，例如：
      ```groovy
      dependencies {
          compileOnly project(':mod-api')
      }
      ```
    - 在 `src/main/java` 下编写你的 Mod 代码，实现相关接口或继承基类。

3. **实现 Mod 主类**
    - 按照 `mod-api` 提供的接口规范，实现你的 Mod 主类。
    - 示例：
      ```java
      public class MyMod implements GameMod {
          @Override
          default void initialize(WorldConfigurationBuilder configBuilder) {
                // Mod 初始化逻辑
          }
      }
      ```

4. **配置 Mod 信息**
    - 在资源目录（如 `src/main/resources`）下添加 mod 描述文件 mod.conf，填写 mainClass：Mod 主类的全限定类名。

---

## Mod 打包流程

1. **编译打包**
    - 在 Mod 项目根目录下执行：
      ```
      ./gradlew build
      ```
    - 编译完成后，生成的 Mod jar 包会在 `build/libs/` 目录下。

2. **部署与测试**
    - 将打包好的 jar 文件放入游戏的 `mods` 目录。
    - 启动游戏，检查 Mod 是否被正确加载。

---

## 其他说明

- 如需开发新的 Mod API，请在 `mod-api` 模块中扩展相关接口。
- 如需修改游戏核心逻辑，请在 `core` 模块中进行开发。

---

## 致谢

特别感谢 [lzt841](https://gitee.com/lzt841) 提供的 PluginFileHandle，有效支持了 mods 资源的加载。