Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/.vitepress/config/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,32 @@ function nav(): DefaultTheme.NavItem[] {

function wikiSidebar(): DefaultTheme.SidebarItem[] {
return [
{
text: "用户指南",
collapsed: false,
base: "/zh/wiki/end-user-guide/",
items: [
{
text: "引言",
link: "introduction"
},
{
text: "整合包迁移指南",
link: "preparing-your-modpack"
},
{
text: "安装教程",
collapsed: true,
base: "/zh/wiki/end-user-guide//installation/",
items: [
{ text: "客户端", link: "install-client" },
{ text: "服务端", link: "install-server" }]
},
{
text: "JVM 参数",
link: "args"
}]
},
{
text: "Cleanroom 模组开发",
collapsed: false,
Expand Down
33 changes: 33 additions & 0 deletions docs/zh/wiki/end-user-guide/args.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: JVM Arguments
---

# JVM 参数

## 概述

在旧版 Java(如 Java 8)上运行 Minecraft 时,JVM 参数对于性能优化至关重要。<br>
而在现代 JVM(Java 17+)中,由于性能调优已在开箱即用的情况下得到良好处理,大多数此类优化已不再必要。<br>
话虽如此,仍有少数参数能带来显著的性能提升。<br>
请记住,JVM 调优是**依赖于硬件的**:在一个系统上有效的参数,在另一个系统上可能不会产生相同的结果。<br>

## 关于发行版

GraalVM 已停止维护,转而推荐使用 OpenJDK。我们建议使用 [Zulu](https://www.azul.com/downloads/ ) 或 [Temurin](https://adoptium.net/temurin/releases?version=25&mode=filter&os=any&arch=any )。<br>

## 实用参数

::: info 注意 {id="note"}
请确保 `-Xms` 和 `-Xmx` 的值相同。这可以防止 JVM 动态调整堆大小,并有助于避免内存溢出(OOM)崩溃。(如果您使用的是启动器,请确保“最大内存”与“最小内存”设置相等)<br>
:::

- `-XX:+UseCompactObjectHeaders` <br> 将 JVM 中的对象头大小从 96–128 位减少到 64 位,从而降低堆内存使用量并可能提升性能。_Java 25_ 已将其作为正式功能引入 ([参见 JEP 450](https://openjdk.org/jeps/450 )) ([参见 JEP 519](https://openjdk.org/jeps/519 ))

- `-XX:+UseZGC` <br> 启用 **ZGC**,它提供极低延迟的垃圾回收,几乎可以消除 GC 停顿。

## 注意事项

- Cleanroom Loader 最新测试通过的 Java 版本是 **Java 25**,建议使用此版本,并始终优先选择 LTS(长期支持)版本。
- 在较旧的 CPU 上,**ZGC** 可能会消耗较多资源:它会增加 RAM 使用量(因为 ZGC 不使用压缩对象指针),并可能降低性能。<br> <br> 请分别在**启用**和**禁用 ZGC** 的情况下测试您的游戏,并对比结果。您可以通过移除 `-XX:+UseZGC` 参数回退到 Java 25 的默认回收器 (**G1GC**)。
- 使用 ZGC 时,无需手动添加 `-XX:+ZGenerational` 参数。(它在 Java 25 中默认启用)
- 只有 **ZGC** 才能正确处理大堆内存。如果使用 **G1GC**,请确保设置合理的堆大小(不应超过 11-12GB 内存)。
63 changes: 63 additions & 0 deletions docs/zh/wiki/end-user-guide/installation/install-client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Client
---

# 客户端

## 如何在客户端安装 Cleanroom Loader

::: warning {id="warning"}
Cleanroom 对 macOS 的支持尚不完善,可能无法在您的设备上正常运行。
:::

### 关于启动器

运行 Cleanroom Loader 的推荐方式是使用 **基于 MultiMC 的启动器**,例如 **[Prism Launcher](https://prismlauncher.org/download/windows/ )** 或 **[PolyMC](https://polymc.org/download/ )**。
这些启动器获得官方支持,因为其他启动器可能无法正确处理某些原版库文件的移除。

### 手动安装

::: info 注意 {id="note"}
导入 Cleanroom Loader 实例仅支持基于 MultiMC 的启动器。对于其他启动器,请使用installer jar 文件。
:::
步骤:
1. 将 [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue ) 添加到您的模组文件夹中<br>
*(它不会在 Forge 环境中加载)*
2. 将 [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy ) 添加到您的模组文件夹中<br>
*(它不会在 Forge 环境中加载)*
3. :warning: **警告:** 确保您的实例不包含有问题或已弃用的模组。<br>
详见 [整合包迁移指南](/zh/wiki/end-user-guide/preparing-your-modpack) 以获取更多详情。
4. 从 [发布页面](https://github.com/CleanroomMC/Cleanroom/releases ) 下载 `Cleanroom-MMC-instance` 压缩包。
5. 将其导入到您的启动器中。<br>
*(或者,将补丁文件和 JSON 文件解压到现有的 1.12 实例中。)*
6. 在启动器中,选择您安装的 **Java 25** 的 `javaw.exe` 路径。(`javaw.exe` 不会产生任何命令行输出,是正常情况下应使用的版本;而 `java.exe` 会产生命令行输出)
7. *(可选)* 按照 [JVM 参数](/zh/wiki/end-user-guide/args) 部分所述添加 JVM 参数。
8. 将您整合包中的 `/.minecraft` 文件夹(也可以命名为 `/minecraft` 文件夹)复制到您的 Cleanroom 实例中。

### Cleanroom Relauncher

**Cleanroom Relauncher** 是一个 <ins>**仅客户端**</ins> 模组,允许您启动一个 Forge 1.12.2 实例并无缝切换到 Cleanroom Loader。<br>
这对于希望分发既兼容 Forge 又能运行于 Cleanroom 的整合包的 **整合包作者** 特别有用。<br>
它在基于 MultiMC 的启动器和标准启动器中均受支持。<br>
步骤:
1. 将 [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue ) 添加到您的模组列表中<br>
*(它无法在 Forge 环境中加载)*
2. 将 [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy ) 添加到您的模组列表中<br>
*(它无法在 Forge 环境中加载)*
3. :warning: **警告:** 确保您的实例不包含有问题或已弃用的模组。<br>
详见 [准备您的整合包](/zh/wiki/end-user-guide/preparing-your-modpack) 以获取详情。
4. 将 [Cleanroom Relauncher](https://www.curseforge.com/minecraft/mc-mods/cleanroom-relauncher ) 模组添加到您的模组列表中,并使用 **Java 8** 启动游戏。
5. 在 Cleanroom Relauncher 图形界面中,选择您安装的 **Java 25** 的 `javaw.exe` 路径。(`javaw.exe` 不会产生任何命令行输出,是正常情况下应使用的版本;而 `java.exe` 会产生命令行输出)
6. *(可选)* 从 [JVM 参数](/zh/wiki/end-user-guide/args) 部分添加 JVM 参数。
7. 点击 **Relaunch**(重新启动)。

## 注意事项
- 当使用新的 Java 程序时,笔记本电脑用户可能会遇到性能不佳的情况,这是因为 Windows 未将独立显卡分配给该 Java 程序。请确保将 Java 程序 (javaw.exe) 设置为高性能模式。
- Cleanroom Relauncher 的配置文件位于 `config/relauncher.cfg`。<br> 删除此文件将在下次启动时提示设置图形界面。<br>
::: info 注意 {id="note"}
Cleanroom Relauncher 会检查 Cleanroom 更新。因此,当有更新发布时,图形界面将启动。
:::
- :warning: **警告:** 并非所有启动器都与 Cleanroom Loader 兼容。<br> 支持的启动器:
- :white_check_mark: 基于 MultiMC 的启动器 (**Prism Launcher, PolyMC 等**)
- :warning: CurseForge 启动器 *(有限支持)*
- :warning: 官方 Minecraft 启动器 *(有限支持)*
29 changes: 29 additions & 0 deletions docs/zh/wiki/end-user-guide/installation/install-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Server
---

# 服务器

## 如何在服务器上安装 Cleanroom Loader

### 步骤

1. 删除服务器目录中的 `libraries` 文件夹。
2. :warning: **警告:** 确保您的服务器模组列表不包含有问题或已弃用的模组。<br>
详见 [准备您的整合包](/wiki/end-user-guide/preparing-your-modpack) 以获取更多详情。
3. 从 [发布页面](https://github.com/CleanroomMC/Cleanroom/releases ) 下载最新的 `cleanroom-x.x.x-installer.jar` 并运行它。
4. 在安装程序图形界面中,选择 **Install server**(安装服务器)并选择您的服务器目录。
::: info 注意 {id="note"}
或者,您可以在 bat 或 sh 脚本文件中运行 `java -jar installerName.jar --installServer`。
:::
5. 将 [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue ) 添加到您的模组文件夹中<br>
*(它不会在 Forge 环境中加载)*
6. 将 [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy ) 添加到您的模组文件夹中<br>
*(它不会在 Forge 环境中加载)*
7. *(可选)* 按照 [JVM 参数](/wiki/end-user-guide/args) 部分所述,将 JVM 参数添加到服务器的启动文件中。

## 注意事项

- 在 Windows 上,您可以通过更新 **环境变量**,或在启动 bat 文件中使用双引号指定现代 Java 可执行文件的完整路径来指向它,例如:
`"C:/Program Files/.../bin/java.exe"`
- 在 Linux 上,您可以使用 `SDKMAN!` 来管理您的 Java 版本。
20 changes: 20 additions & 0 deletions docs/zh/wiki/end-user-guide/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: 简介
---

# Cleanroom Loader

## 概述

**Cleanroom Loader** 是专为 Minecraft **1.12.2** 打造的现代化 Forge 分支,旨在通过引入当前最新技术来提升游戏性能、加载速度及兼容性。<br>

### 核心特性

- **支持 Java 25** – 使用最新版本的 Java 运行 Minecraft。
- **升级至 LWJGL3** – 受益于现代化的渲染与输入处理机制。
- **扩展兼容性** – 包含多项补丁,使约 99% 的 Forge 模组能够流畅运行。

### 计划中的特性

- **模块化渲染系统** – 对渲染管线进行彻底重构。[查看 Kirino 讨论区](https://github.com/CleanroomMC/Cleanroom/discussions/405 )。
- **改进的 API** – 正在积极开发中,提供实用且对开发者友好的 API。[查看项目看板](https://github.com/orgs/CleanroomMC/projects/4/ )。
Loading