|
1 | | -# Cleanroom Minecraft |
| 1 | +<img src="./images/catroom.png" height="160" alt="CatRoom" align="right"> |
2 | 2 |
|
3 | | -## Features |
4 | | -### Implemented |
| 3 | +# CatRoom |
5 | 4 |
|
6 | | -- 1.12.2 on Java 21 |
7 | | -- *Latest* LWJGL3 |
8 | | -- A working *mod development template/kit* |
9 | | -- Patches for loading incompatible mods |
10 | | -- Built-in Mixin w/ handy bootstrapping |
11 | | -- Develop using Scala 3 + Kotlin 2 |
12 | | -- Compatibility to 99% of Forge mods |
| 5 | +CatRoom is a Cleanroom+Bukkit+Spigot server software forked from [CatServer](https://github.com/Luohuayu/CatServer). |
13 | 6 |
|
14 | | -### Planning |
| 7 | +## Features: |
15 | 8 |
|
16 | | -- CleanroomGradle to replace ForgeGradle |
17 | | -- Classfile API |
18 | | -- Actually useful APIs (See [here](https://github.com/orgs/CleanroomMC/projects/4/)) |
19 | | -- Optimized |
| 9 | +- Replaced Forge with Cleanroom |
| 10 | +- Enhanced mod compatibility |
| 11 | +- Built-in Forge-Bukkit permission bridge |
| 12 | +- Make use of modern Java features |
| 13 | +- Optimized plugin performance |
| 14 | + |
| 15 | +For all fixes, see [fixed upstream issues](FIXED_UPSTREAM_ISSUES.md) |
20 | 16 |
|
21 | 17 | ## Components: |
22 | 18 |
|
|
30 | 26 | - [Scalar](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy), a Scala provider. We made Scala libraries become a standalone mod so it can be updated. |
31 | 27 | - [Forgelin-Continuous](https://www.curseforge.com/minecraft/mc-mods/forgelin-continuous) and [LibrarianLib-Continuous](https://www.curseforge.com/minecraft/mc-mods/librarianlib-continuous) |
32 | 28 |
|
33 | | -## Download & Installation: |
34 | | - |
35 | | -- For MultiMC-based launchers (PolyMC, PrismLauncher), download the MMC instance from [release](https://github.com/CleanroomMC/Cleanroom/releases), import it in your launcher(alternatively unzip patches and json inside to your 1.12 instance). |
36 | | -- For regular launcher (official launcher, AT launcher, FTB, HMCL), install the [relauncher](https://www.curseforge.com/minecraft/mc-mods/cleanroom-relauncher), launch the game and follow instructions. |
37 | | -- **WARNING:** Only MultiMC-based launchers are officially supported. This is because of the limit on removing vanilla libraries in other launchers. |
38 | | -- **Remember to install [Fugue](https://www.curseforge.com/minecraft/mc-mods/fugue)!** |
39 | | -- **And [Scalar](https://www.curseforge.com/minecraft/mc-mods/scalar-legacy)!** |
40 | | -- If you were told to use **action builds** (aka bleeding edge), here: [Cleanroom](https://github.com/CleanroomMC/Cleanroom/actions), [Fugue](https://github.com/CleanroomMC/Fugue/actions) |
41 | | -- You need to log in your GitHub account to download action artifacts. |
42 | | - |
43 | | -## Cleanroom on Server |
44 | | - |
45 | | -- Cleanroom can be installed on server. |
46 | | -- Just use the installer mentioned in previous section, and run the jar with `--intallServer`. See [this page](https://minecraft.fandom.com/wiki/Tutorials/Setting_up_a_Minecraft_Forge_server) for more detail. |
47 | | - |
48 | | -## Pack-making with Cleanroom |
49 | | - |
50 | | -### Steps of Migrating to Cleanroom |
51 | | - |
52 | | -1. Add Scalar and Fugue in your pack. |
53 | | -2. Add Relauncher (optional, this will make your pack a full Cleanroom pack) |
54 | | -3. Test launching and remove incompatible mods |
55 | | - |
56 | 29 | ### About Cross-compat Between Forge and Cleanroom |
57 | 30 |
|
58 | 31 | - Cleanroom mods (Fugue, Scalar) will be ignored by Forge, so then won't crash existed players |
|
0 commit comments