FamilyFunPack开源项目使用指南

1. 项目目录结构及介绍

FamilyFunPack项目的目录结构如下：

FamilyFunPack/
├── .github/              # 存放GitHub工作流文件
│   └── workflows/
├── gradle/               # Gradle构建脚本和配置文件
│   ├── wrapper/
│   └── build.gradle
├── src/                  # 源代码目录
│   └── main/
├── .gitignore            # 指定Git应该忽略的文件和目录
├── CREDITS.txt           # 项目贡献者信息
├── LICENSE.txt           # 项目许可证文件
├── LICENSE-Paulscode IBXM Library.txt  # 第三方库许可证文件
├── LICENSE-Paulscode SoundSystem CodecIBXM.txt  # 第三方库许可证文件
├── README.md             # 项目说明文件
├── build.gradle          # Gradle构建脚本
├── gradle.properties      # Gradle配置文件
├── gradlew               # Gradle命令行工具
├── gradlew.bat           # Gradle命令行工具的Windows版本
├── modules.md            # 项目模块介绍
└── commands.md           # 项目命令介绍

• .github/: 存放与GitHub操作相关的脚本和工作流定义，例如自动化构建、测试等。
• gradle/: 包含构建项目所需的Gradle配置和脚本。
• src/: 存放项目的主要源代码。
• .gitignore: 定义了哪些文件和目录应该被Git版本控制系统忽略。
• CREDITS.txt: 列出了为项目做出贡献的人员名单。
• LICENSE.txt: 项目的开源许可证信息。
• README.md: 项目的说明文档，通常包含项目描述、使用方法和安装步骤等。
• build.gradle: Gradle构建脚本，用于配置和构建项目。
• gradle.properties: Gradle的属性文件，用于定义全局的Gradle属性。
• gradlew 和 gradlew.bat: 分别是Gradle的命令行工具的Unix和Windows版本。

2. 项目的启动文件介绍

项目的主要启动文件是gradlew和gradlew.bat。这两个文件分别是用于Unix系统（如Linux和macOS）和Windows系统的Gradle命令行工具。

• gradlew: 在Unix系统上，可以通过命令行运行./gradlew runClient来启动项目的客户端。
• gradlew.bat: 在Windows系统上，可以通过命令行运行gradlew.bat runClient来启动项目的客户端。

runClient是Gradle任务，用于启动Minecraft客户端并加载FamilyFunPack模组。

3. 项目的配置文件介绍

项目的配置文件主要包括：

• build.gradle: 这是项目的主要构建配置文件，用于定义项目的构建逻辑，包括依赖关系、构建任务、源代码目录等。

  示例配置片段：

  plugins {
      id 'java'
  }
  
  group 'com.example'
  version '1.0-SNAPSHOT'
  
  repositories {
      mavenCentral()
  }
  
  dependencies {
      // 添加项目依赖
  }
  
  // 定义构建任务
  task runClient(type: JavaExec) {
      // 配置任务参数
  }
  

• gradle.properties: 该文件用于定义Gradle的全局属性，例如JVM参数、Gradle版本等。

  示例配置片段：

  org.gradle.jvmargs=-Xmx1024m
  

通过正确配置这些文件，您可以构建和运行FamilyFunPack项目，并根据需要调整项目设置。