You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* - Split Superseded list into categories
- Added Warning for Celeritas incompat
- Extended superseded list
- Improved Args page
- Added macOS warning
* Added more linespaces
* Changed br/ to br :)
* Further PR changes
* No more JourneyMap to Xaero :c
* smol typo
* dot
* Fix companion mods
* Extended Companion list
* Typo 2
* Add clarification
* Java instead of javaw for server
* Further List Change
Copy file name to clipboardExpand all lines: docs/wiki/end-user-guide/args.md
+19-9Lines changed: 19 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,28 @@ title: JVM Arguments
6
6
7
7
## Overview
8
8
9
-
JVM arguments were once crucial for performance optimization in Minecraft when running on older Java versions (such as Java 8).<br/>
10
-
With modern JVMs (Java 17+), most of these optimizations are no longer necessary, as performance tuning is handled well out of the box.<br/>
11
-
That said, a few arguments can still provide noticeable improvements.<br/>
12
-
Keep in mind that JVM tuning is **hardware-dependent**: an argument that helps on one system may not yield the same results on another.<br/>
9
+
JVM arguments were once crucial for performance optimization in Minecraft when running on older Java versions (such as Java 8).<br>
10
+
With modern JVMs (Java 17+), most of these optimizations are no longer necessary, as performance tuning is handled well out of the box.<br>
11
+
That said, a few arguments can still provide noticeable improvements.<br>
12
+
Keep in mind that JVM tuning is **hardware-dependent**: an argument that helps on one system may not yield the same results on another.<br>
13
+
14
+
## About Distributions
15
+
16
+
GraalVM is being discontinued in favor of OpenJDK. We recommend to use [Zulu](https://www.azul.com/downloads/) or [Temurin](https://adoptium.net/temurin/releases?version=25&mode=filter&os=any&arch=any).<br>
13
17
14
18
## Useful Arguments
15
19
16
-
-`-XX:+UnlockExperimentalVMOptions -XX:+UseCompactObjectHeaders` <br/> *Introduced in Java 24.* <br/> Reduces the size of object headers in the JVM from 96–128 bits down to 64 bits, lowering heap usage and potentially improving performance. _Java_ 25 made this a product feature ([See JEP 450](https://openjdk.org/jeps/450)) ([See JEP 519](https://openjdk.org/jeps/519))<br/>
20
+
::: info Note {id="note"}
21
+
Make sure `-Xms` and `-Xmx` have the same size. This makes sure the JVM does not have to resize, and will avoid OOM crashes (if you're using a launcher, make sure Max ram is equal to Min ram)<br>
22
+
:::
17
23
18
-
-`-XX:+UseZGC` <br/> Enables the **Z Garbage Collector (ZGC)**, which provides very low latency garbage collection and can virtually eliminate GC pauses. <br/>
24
+
-`-XX:+UseCompactObjectHeaders` <br> Reduces the size of object headers in the JVM from 96–128 bits down to 64 bits, lowering heap usage and potentially improving performance. _Java_ 25 made this a product feature ([See JEP 450](https://openjdk.org/jeps/450)) ([See JEP 519](https://openjdk.org/jeps/519))
25
+
26
+
-`-XX:+UseZGC` <br> Enables the **Z Garbage Collector (ZGC)**, which provides very low latency garbage collection and can virtually eliminate GC pauses.
19
27
20
28
## Notes
21
-
- The latest tested Java version for Cleanroom Loader is **Java 25**, it is recommended to use this version<br/>
22
-
- On older CPUs, **ZGC** can be demanding: it increases RAM usage (since ZGC does not use compressed object pointers) and may reduce performance. <br/> <br/> Test your game both **with** and **without ZGC**, and compare results. You can revert to Java 24’s default collector (**G1GC**) by removing `-XX:+UseZGC`<br/>
23
-
- The use of `-XX:+ZGenerational` is not required when using ZGC. (It is enabled by default in Java 25)<br/>
29
+
30
+
- The latest tested Java version for Cleanroom Loader is **Java 25**, it is recommended to use this version, and to always stick to LTS versions.
31
+
- On older CPUs, **ZGC** can be demanding: it increases RAM usage (since ZGC does not use compressed object pointers) and may reduce performance. <br> <br> Test your game both **with** and **without ZGC**, and compare results. You can revert to Java 25’s default collector (**G1GC**) by removing `-XX:+UseZGC`
32
+
- The use of `-XX:+ZGenerational` is not required when using ZGC. (It is enabled by default in Java 25)
33
+
- Big heaps can only be correctly handled by **ZGC**. If using **G1GC**, make sure to pick reasonable heap sizes (Shouldn't exceed 11-12GB ram)
Copy file name to clipboardExpand all lines: docs/wiki/end-user-guide/installation/install-client.md
+37-31Lines changed: 37 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,52 +6,58 @@ title: Client
6
6
7
7
## How to Install Cleanroom Loader on the Client
8
8
9
+
::: warning {id="warning"}
10
+
macOS is not well-supported by Cleanroom, and may or may not work for you
11
+
:::
12
+
9
13
### About Launchers
10
14
11
-
The recommended way to run Cleanroom Loader is with a **MultiMC-based launcher**, such as **[Prism Launcher](https://prismlauncher.org/download/windows/)** or **[PolyMC](https://polymc.org/download/)**.<br/>
12
-
These are officially supported because other launchers may not properly handle the removal of certain vanilla libraries.<br/>
15
+
The recommended way to run Cleanroom Loader is with a **MultiMC-based launcher**, such as **[Prism Launcher](https://prismlauncher.org/download/windows/)** or **[PolyMC](https://polymc.org/download/)**.<br>
16
+
These are officially supported because other launchers may not properly handle the removal of certain vanilla libraries.<br>
13
17
14
18
### Manual Install
15
19
16
20
::: info Note {id="note"}
17
21
Importing Cleanroom Loader instance is only supported on MultiMC-based launchers. For other launchers, use the installer jar.
18
22
:::
19
23
Steps:
20
-
1. Add [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue) to your mod folder<br/>
21
-
*(it will not load in a Forge environment)*<br/>
22
-
2. Add [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy) to your mod folder<br/>
23
-
*(it will not load in a Forge environment)*<br/>
24
-
3.:warning:**Warning:** Make sure your instance does not include problematic or deprecated mods.<br/>
25
-
See [Preparing your modpack](/wiki/end-user-guide/preparing-your-modpack) for more details.<br/>
26
-
4. Download the `Cleanroom-MMC-instance-` archive from the [Releases page](https://github.com/CleanroomMC/Cleanroom/releases).<br/>
27
-
5. Import it into your launcher.<br/>
28
-
*(Alternatively, unzip the patches and JSON files into an existing 1.12 instance.)*<br/>
29
-
6. In your launcher, select the `javaw.exe` path of your **Java 25 installation**. (`javaw.exe` will not produce any command-line output and it the one that should be used in normal cases, while `java.exe` will produce a command-line output)<br/>
30
-
7.*(Optional)* Add JVM arguments as described in the [JVM Arguments](/wiki/end-user-guide/args) section.<br/>
24
+
1. Add [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue) to your mod folder<br>
25
+
*(it will not load in a Forge environment)*
26
+
2. Add [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy) to your mod folder<br>
27
+
*(it will not load in a Forge environment)*
28
+
3.:warning:**Warning:** Make sure your instance does not include problematic or deprecated mods.<br>
29
+
See [Preparing your modpack](/wiki/end-user-guide/preparing-your-modpack) for more details.
30
+
4. Download the `Cleanroom-MMC-instance` archive from the [Releases page](https://github.com/CleanroomMC/Cleanroom/releases).
31
+
5. Import it into your launcher.<br>
32
+
*(Alternatively, unzip the patches and JSON files into an existing 1.12 instance.)*
33
+
6. In your launcher, select the `javaw.exe` path of your **Java 25 installation**. (`javaw.exe` will not produce any command-line output and it the one that should be used in normal cases, while `java.exe` will produce a command-line output)
34
+
7.*(Optional)* Add JVM arguments as described in the [JVM Arguments](/wiki/end-user-guide/args) section.
35
+
8. Copy over the `/.minecraft` folder (can also be named `/minecraft` folder) from your modpack over to your Cleanroom instance.
31
36
32
37
### Cleanroom Relauncher
33
38
34
-
**Cleanroom Relauncher** is a <ins>**Client-side**</ins> mod that allows you to start a Forge 1.12.2 instance and seamlessly switch to Cleanroom Loader.<br/>
35
-
This is particularly useful for **modpack authors** who want to distribute Forge-compatible packs that can also run on Cleanroom.<br/>
36
-
It is supported in both MultiMC-based launchers and standard launchers.<br/>
39
+
**Cleanroom Relauncher** is a <ins>**Client-side**</ins> mod that allows you to start a Forge 1.12.2 instance and seamlessly switch to Cleanroom Loader.<br>
40
+
This is particularly useful for **modpack authors** who want to distribute Forge-compatible packs that can also run on Cleanroom.<br>
41
+
It is supported in both MultiMC-based launchers and standard launchers.<br>
37
42
Steps:
38
-
1. Add [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue) to your modlist<br/>
39
-
*(it will not load in a Forge environment)*<br/>
40
-
2. Add [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy) to your modlist<br/>
41
-
*(it will not load in a Forge environment)*<br/>
42
-
3.:warning:**Warning:** Ensure your instance does not contain problematic or deprecated mods.<br/>
43
-
See [Preparing your modpack](/wiki/end-user-guide/preparing-your-modpack) for details.<br/>
44
-
4. Add the [Cleanroom Relauncher](https://www.curseforge.com/minecraft/mc-mods/cleanroom-relauncher) mod to your modlist and launch the game with **Java 8**.<br/>
45
-
5. In the Cleanroom Relauncher GUI, select the `javaw.exe` path of your **Java 25 installation**. (`javaw.exe` will not produce any command-line output and it the one that should be used in normal cases, while `java.exe` will produce a command-line output)<br/>
46
-
6.*(Optional)* Add JVM arguments from the [JVM Arguments](/wiki/end-user-guide/args) section.<br/>
47
-
7. Click **Relaunch**.<br/>
43
+
1. Add [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue) to your modlist<br>
44
+
*(it will not load in a Forge environment)*
45
+
2. Add [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy) to your modlist<br>
46
+
*(it will not load in a Forge environment)*
47
+
3.:warning:**Warning:** Ensure your instance does not contain problematic or deprecated mods.<br>
48
+
See [Preparing your modpack](/wiki/end-user-guide/preparing-your-modpack) for details.
49
+
4. Add the [Cleanroom Relauncher](https://www.curseforge.com/minecraft/mc-mods/cleanroom-relauncher) mod to your modlist and launch the game with **Java 8**.
50
+
5. In the Cleanroom Relauncher GUI, select the `javaw.exe` path of your **Java 25 installation**. (`javaw.exe` will not produce any command-line output and it the one that should be used in normal cases, while `java.exe` will produce a command-line output)
51
+
6.*(Optional)* Add JVM arguments from the [JVM Arguments](/wiki/end-user-guide/args) section.
52
+
7. Click **Relaunch**.
48
53
49
54
## Notes
50
-
- Cleanroom Relauncher’s configuration file can be found at `config/relauncher.cfg`. <br/> Deleting this file will prompt the setup GUI on the next launch.<br/>
55
+
56
+
- Cleanroom Relauncher’s configuration file can be found at `config/relauncher.cfg`. <br> Deleting this file will prompt the setup GUI on the next launch.<br>
51
57
::: info Note {id="note"}
52
58
Cleanroom Relauncher will check for cleanroom updates. Therefore, the UI will launch when an update rolls out.
53
59
:::
54
-
-:warning:**Warning:** Not all launchers are compatible with Cleanroom Loader. <br/> Supported launchers:
Copy file name to clipboardExpand all lines: docs/wiki/end-user-guide/installation/install-server.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,19 +8,19 @@ title: Server
8
8
9
9
### Steps
10
10
11
-
1. Delete the `libraries` folder inside your server directory.<br/>
12
-
2.:warning:**Warning:** Ensure your server modlist does not include problematic or deprecated mods.<br/>
13
-
See [Preparing your modpack](/wiki/end-user-guide/preparing-your-modpack) for more details.<br/>
14
-
3. Download the latest `cleanroom-x.x.x-installer.jar` from the [Releases page](https://github.com/CleanroomMC/Cleanroom/releases) and run it.<br/>
15
-
4. In the installer GUI, select **Install server** and choose your server’s directory.<br/>
16
-
5. Add [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue) to your mod folder<br/>
17
-
*(it will not load in a Forge environment)*<br/>
18
-
6. Add [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy) to your mod folder<br/>
19
-
*(it will not load in a Forge environment)*<br/>
20
-
7.*(Optional)* Add JVM arguments to your server’s launch file as described in the [JVM Arguments](/wiki/end-user-guide/args) section.<br/>
11
+
1. Delete the `libraries` folder inside your server directory.
12
+
2.:warning:**Warning:** Ensure your server modlist does not include problematic or deprecated mods.<br>
13
+
See [Preparing your modpack](/wiki/end-user-guide/preparing-your-modpack) for more details.
14
+
3. Download the latest `cleanroom-x.x.x-installer.jar` from the [Releases page](https://github.com/CleanroomMC/Cleanroom/releases) and run it.
15
+
4. In the installer GUI, select **Install server** and choose your server’s directory.
16
+
5. Add [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue) to your mod folder<br>
17
+
*(it will not load in a Forge environment)*
18
+
6. Add [Scalar Legacy](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy) to your mod folder<br>
19
+
*(it will not load in a Forge environment)*
20
+
7.*(Optional)* Add JVM arguments to your server’s launch file as described in the [JVM Arguments](/wiki/end-user-guide/args) section.
21
21
22
22
## Notes
23
23
24
24
- On Windows, you can point to modern Java executables either by updating your **Environment Variables** or by specifying the full path between double quotes in the Launch bat, e.g.:
25
-
`"C:/Program Files/.../bin/javaw.exe"`<br/>
26
-
- On Linux, you can use `SDKMAN!` to manage your java versions.<br/>
25
+
`"C:/Program Files/.../bin/java.exe"`
26
+
- On Linux, you can use `SDKMAN!` to manage your java versions.
Copy file name to clipboardExpand all lines: docs/wiki/end-user-guide/introduction.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,16 @@ title: Introduction
5
5
# Cleanroom Loader
6
6
7
7
## Overview
8
-
**Cleanroom Loader** is a modern fork of Forge for Minecraft **1.12.2**, designed to bring the game up to date with current technology while improving performance, load times and compatibility.<br/>
8
+
9
+
**Cleanroom Loader** is a modern fork of Forge for Minecraft **1.12.2**, designed to bring the game up to date with current technology while improving performance, load times and compatibility.<br>
10
+
9
11
### Key Features
10
-
-**Java 25 support** – run Minecraft with the latest Java versions.<br/>
11
-
-**Upgraded LWJGL3** – benefit from modern rendering and input handling.<br/>
12
-
-**Extended compatibility** – includes patches that allow nearly ≈99% Forge mods to run smoothly.<br/>
12
+
13
+
-**Java 25 support** – run Minecraft with the latest Java versions.
14
+
-**Upgraded LWJGL3** – benefit from modern rendering and input handling.
15
+
-**Extended compatibility** – includes patches that allow nearly ≈99% Forge mods to run smoothly.
16
+
13
17
### Planned Features
14
-
-**Modular Render System** – a complete rework of the rendering pipeline. [See Kirino discussion](https://github.com/CleanroomMC/Cleanroom/discussions/405).<br/>
15
-
-**Improved APIs** – practical, developer-friendly APIs under active development. [See Project board](https://github.com/orgs/CleanroomMC/projects/4/).<br/>
18
+
19
+
-**Modular Render System** – a complete rework of the rendering pipeline. [See Kirino discussion](https://github.com/CleanroomMC/Cleanroom/discussions/405).
20
+
-**Improved APIs** – practical, developer-friendly APIs under active development. [See Project board](https://github.com/orgs/CleanroomMC/projects/4/).
0 commit comments