Skip to content

Fork of CatRoom, aiming to improve Forge-Bukkit compatibility and fix behavior inconsistencies.

License

Notifications You must be signed in to change notification settings

HaHaWTH/CatRoom

This branch is 4 commits ahead of, 8 commits behind NovaEngineering-Source/CatRoom:bouncedpad.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5bf28b7 · Dec 31, 2024
Dec 17, 2024
Dec 23, 2023
Dec 16, 2024
Dec 17, 2024
Dec 31, 2024
Dec 31, 2024
May 4, 2024
May 4, 2024
Feb 18, 2024
Dec 26, 2024
Feb 15, 2023
Dec 26, 2024
Dec 31, 2024
Oct 7, 2024
Dec 1, 2023
Feb 15, 2023
Feb 18, 2023
Feb 15, 2023

Repository files navigation

CatRoom

CatRoom

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

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.

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. Build with gradlew build

Development Tips:

  • Only modify projects/cleanroom/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 manual clean up their patches

Mod Development:

There's an unofficial template exist. Note: You need to build before run.

A porting guide is available in Cleanroom wiki.

Roadmap flow chart

Loading
graph TD;
    A(Mixin integration)-->D(Bouncepad overhaul - we are here);
    B(LWJGL compat)-->D;
    C(Newer Java compat)-->D;
    D-->E(Config any time);
    D-->G(Minor improvement and fixes)
    E-->F(Greater improvement needs configs)
    X(Cleanroom Gradle)-->D
    D-->X
    D-->Y(Better Mixin Integration)
    Y-->D

About

Fork of CatRoom, aiming to improve Forge-Bukkit compatibility and fix behavior inconsistencies.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 99.6%
  • Groovy 0.4%