CatRoom

CatRoom is a Cleanroom+Bukkit+Spigot server software forked from CatServer.

This fork is supporting by VoidStudio. We are on Discord!

Cleanroom version: 0.3.24-alpha

Warnings

• Java 25 is unstable and may cause problems

Features:

• Replaced Forge with Cleanroom
• Enhanced mod compatibility
• Built-in Forge-Bukkit permission bridge
• Make use of modern Java features
• Optimized plugin performance

For all fixes, see fixed upstream issues

Components:

• Minecraft Coder Pack
• CleanroomLoader (Continuation + Revamp of ForgeModLoader)
• Cleanroom Minecraft (Continuation + Revamp of MinecraftForge)
• Customized Mixin
• Bytecode Patcher (Coming Soon) [Inspired by Bansoukou and Bytecode Patcher]
• Fugue, a mod patches many incompatibilities.
• Javassist
• Scalar, a Scala provider. We made Scala libraries become a standalone mod so it can be updated.
• Forgelin-Continuous and LibrarianLib-Continuous

About Cross-compat Between Forge and Cleanroom

• Cleanroom mods (Fugue, Scalar) will be ignored by Forge, so then won't crash existed players
• Cleanroom integrated mods (MixinBooter, ConfigAnyTime) will be ignored by Cleanroom, then won't crash new players
• The version of built-in MixinBooter is configurable in forge_early.cfg

List of Obsoleted/Incompatible Mods

• SpongeForge: Use SpongeForge LTS
• Phosphor: Use Hesperus or Alfheim Lighting Engine
• Forgelin: Use Forgelin-Continuous
• LibrarianLib: Use LibrarianLib-Continuous
• JustEnoughIds: Use RoughlyEnoughIDs
• AdvancedShader: Binary patching, incompatible
• Polyfrost series: Waiting for official fix
• Essential.gg: Patched but still buggy

Build Instructions:

1. Clone this repository
2. Import the build.gradle into your IDE (most preferably IntelliJ IDEA)
3. Once the import has finished, run gradlew setup
4. Run gradlew --stop to stop the daemon and prevent ForgeGradle gone wrong
5. Build with gradlew build

Development Tips:

• Only modify projects/catroom/src/ directory if you want to change vanilla
• Run gradlew genPatches before commit, or the changes won't exist
• Modifications on src/ doesn't need generating patches
• Tips from Forge are still apply, keep the patches clean!
• The current patches is full of useless hunks after we switched to VineFlower, we encourage contributors to clean up these patches manually.

Mod Development:

Official template is here: template

A porting guide is available in Cleanroom wiki (WIP).