Sodium-Fabric 项目安装与使用教程

Sodium-Fabric 项目安装与使用教程

sodium-fabric A Fabric mod designed to improve frame rates and reduce micro-stutter 项目地址: https://gitcode.com/gh_mirrors/so/sodium-fabric

1. 项目目录结构及介绍

Sodium-Fabric 项目的目录结构如下：

sodium-fabric/
├── common/
├── fabric/
├── gradle/wrapper/
├── idea/
├── neoforge/
├── thirdparty/
├── .editorconfig
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── build.gradle.kts
├── gradle.properties
├── gradlew
├── gradlew.bat
├── settings.gradle.kts

目录介绍：

• common/: 包含项目的通用代码。
• fabric/: 包含与 Fabric 相关的代码。
• gradle/wrapper/: 包含 Gradle Wrapper 文件，用于确保项目使用特定版本的 Gradle。
• idea/: 包含 IntelliJ IDEA 的项目配置文件。
• neoforge/: 包含与 NeoForge 相关的代码。
• thirdparty/: 包含第三方库和依赖。
• .editorconfig: 配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.md: 项目许可证。
• README.md: 项目介绍和使用说明。
• build.gradle.kts: Gradle 构建脚本。
• gradle.properties: Gradle 属性配置文件。
• gradlew: Gradle Wrapper 脚本（Unix）。
• gradlew.bat: Gradle Wrapper 脚本（Windows）。
• settings.gradle.kts: Gradle 项目设置文件。

2. 项目启动文件介绍

Sodium-Fabric 项目的启动文件主要涉及 Gradle 构建脚本和 Minecraft 客户端的启动配置。

主要启动文件：

• build.gradle.kts: 这是项目的 Gradle 构建脚本，定义了项目的依赖、任务和构建配置。通过运行 ./gradlew build 或 gradlew.bat build 可以编译项目。
• gradlew: 这是 Gradle Wrapper 脚本，用于在 Unix 系统上启动 Gradle 构建。
• gradlew.bat: 这是 Gradle Wrapper 脚本，用于在 Windows 系统上启动 Gradle 构建。

启动步骤：

1. 打开终端或命令提示符。
2. 导航到项目根目录。
3. 运行 ./gradlew build（Unix）或 gradlew.bat build（Windows）来编译项目。
4. 编译完成后，生成的 mod 文件将位于 build/libs/ 目录下。

3. 项目配置文件介绍

Sodium-Fabric 项目的配置文件主要包括 Gradle 配置文件和 Minecraft 客户端的配置文件。

主要配置文件：

• gradle.properties: 这个文件包含 Gradle 构建的属性配置，如 Java 版本、Maven 仓库等。
• settings.gradle.kts: 这个文件定义了项目的模块和依赖关系。
• .editorconfig: 这个文件用于配置代码风格，确保不同开发者之间的代码风格一致。

配置示例：

gradle.properties

# Gradle properties
org.gradle.jvmargs=-Xmx2048M
org.gradle.java.home=/path/to/java/home

settings.gradle.kts

rootProject.name = "sodium-fabric"
include("common", "fabric", "neoforge")

.editorconfig

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

通过这些配置文件，可以确保项目的构建和代码风格的一致性。

sodium-fabric A Fabric mod designed to improve frame rates and reduce micro-stutter 项目地址: https://gitcode.com/gh_mirrors/so/sodium-fabric