Yarn 项目使用教程

Yarn 项目使用教程

yarn Libre Minecraft mappings, free to use for everyone. No exceptions. 项目地址: https://gitcode.com/gh_mirrors/yarn8/yarn

1. 项目目录结构及介绍

Yarn 项目是一个用于Minecraft游戏的开放映射集，其目录结构如下：

• .github/: 存放GitHub特定的配置文件。
• filament/: 与项目相关但不常用的文件。
• gradle/: 包含构建项目所需的Gradle配置文件。
• mappings/: 存放映射文件，这些文件用于将Minecraft的混淆代码转换为可读代码。
• src/: 源代码目录，可能包含项目的核心代码。
• unpick-definitions/: 包含用于解包Minecraft JAR文件的定义文件。
• editorconfig/: 包含编辑器配置文件，用于统一开发者的代码风格。
• .gitattributes/: Git属性文件，用于设置特定文件的Git行为。
• .gitignore/: Git忽略文件，用于指定在Git版本控制中应该忽略的文件。
• CONTRIBUTING.md: 包含贡献代码时应遵守的指南。
• CONVENTIONS.md: 包含项目约定的文档。
• HEADER: 项目头部文件，可能包含版权信息。
• LICENSE: 项目许可证文件，本项目使用CC0-1.0许可证。
• MAINTAINERS: 项目维护者列表。
• README.md: 项目自述文件，提供项目的基本信息和说明。
• build.gradle: Gradle构建脚本，用于构建和打包项目。
• enigma_profile.json: Enigma配置文件，Enigma是一个用于编辑映射的工具。
• gradle.properties: Gradle属性文件，包含构建时的属性设置。
• gradlew 和 gradlew.bat: Gradle的命令行工具，用于运行Gradle任务。
• settings.gradle: Gradle设置文件，用于配置Gradle项目。

2. 项目的启动文件介绍

Yarn 项目的启动主要是通过Gradle任务来完成的。以下是一些主要的启动文件和任务：

• gradlew: Linux和macOS系统上用于运行Gradle任务的脚本。
• gradlew.bat: Windows系统上用于运行Gradle任务的批处理文件。
• build.gradle: 包含了项目的构建逻辑，其中包括了以下任务：
  • yarn: 设置并下载Enigma的最新版本，并自动使用合并的JAR文件和映射。
  • yarnUnpicked: 与yarn类似，但会解包常量并使用它们启动Enigma。
  • yarnCommon: 仅显示常见类的yarn任务。
  • build: 构建一个包含映射的GZip压缩档案。
  • mapNamedJar: 构建一个包含Yarn映射和自动映射字段（枚举等）的解混淆JAR文件。

3. 项目的配置文件介绍

在Yarn项目中，配置文件主要涉及以下几个方面：

• editorconfig/: 这个目录下的文件定义了代码编辑器的行为，比如缩进风格和换行符等，以确保团队成员的代码风格一致性。
• gradle.properties: 这个文件包含了影响Gradle构建过程的各种属性，例如Java版本设置等。
• enigma_profile.json: 这是Enigma编辑器的配置文件，可以自定义Enigma的行为和外观。

通过正确配置这些文件，可以确保项目的构建和开发过程顺利进行。

yarn Libre Minecraft mappings, free to use for everyone. No exceptions. 项目地址: https://gitcode.com/gh_mirrors/yarn8/yarn