Rubidium 项目使用教程

Rubidium 项目使用教程

Rubidium Rubidium is an Unofficial Fork of CaffeineMC's "Sodium", made to work with Forge Mod Loader. 项目地址: https://gitcode.com/gh_mirrors/ru/Rubidium

1. 项目目录结构及介绍

Rubidium 项目的目录结构如下：

Rubidium/
├── .github/
│   └── workflows/
├── gradle/
│   └── wrapper/
├── src/
│   └── main/
├── .gitignore
├── LICENSE
├── Logo.jpeg
├── README.md
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
└── settings.gradle

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• gradle/wrapper/: 包含 Gradle Wrapper 的相关文件，用于确保项目使用特定版本的 Gradle。
• src/main/: 项目的源代码目录，包含主要的 Java 代码和其他资源文件。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被版本控制。
• LICENSE: 项目的许可证文件，本项目使用 LGPL-3.0 许可证。
• Logo.jpeg: 项目的 Logo 图片。
• README.md: 项目的说明文件，包含项目的基本信息和使用说明。
• build.gradle: Gradle 构建脚本，定义项目的构建配置。
• gradle.properties: Gradle 属性文件，包含项目的配置属性。
• gradlew: Gradle Wrapper 的 Unix 脚本。
• gradlew.bat: Gradle Wrapper 的 Windows 批处理脚本。
• settings.gradle: Gradle 设置文件，定义项目的模块和仓库配置。

2. 项目启动文件介绍

Rubidium 项目的启动文件主要依赖于 Gradle 构建系统。要启动项目，首先需要确保已安装 Java 和 Gradle。

启动步骤

1. 克隆项目:

   git clone https://github.com/Asek3/Rubidium.git
   cd Rubidium
   

2. 使用 Gradle 构建项目:

   ./gradlew build
   

3. 运行项目:

   ./gradlew run
   

3. 项目配置文件介绍

Rubidium 项目的主要配置文件包括 build.gradle 和 gradle.properties。

build.gradle

build.gradle 是 Gradle 构建脚本，定义了项目的构建配置。以下是一些关键配置项：

plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    // 项目依赖
}

jar {
    manifest {
        attributes 'Main-Class': 'com.example.Main'
    }
}

gradle.properties

gradle.properties 文件包含项目的配置属性，例如 Java 版本、编码等。

org.gradle.java.home=/path/to/java/home
org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m

通过以上配置，可以确保项目在不同环境中的一致性和可重复性。

---

以上是 Rubidium 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你顺利开始使用 Rubidium 项目。

Rubidium Rubidium is an Unofficial Fork of CaffeineMC's "Sodium", made to work with Forge Mod Loader. 项目地址: https://gitcode.com/gh_mirrors/ru/Rubidium