Skip to content

qborder/Helium

Repository files navigation

Helium

lightweight client-side performance mod for Minecraft

NEW MOD: https://gitlab.com/mslow/Catalyst

Modrinth GitHub Build License

Download on Modrinth · Report Issues


this is the development repository for Helium. if you're just looking to install the mod, grab it from Modrinth. the page there has all the feature descriptions and pretty screenshots and stuff.


Building From Source

you'll need Java 21 installed. that's it. gradle wrapper handles everything else.

git clone https://github.com/qborder/Helium.git
cd Helium

build the mod:

./gradlew remapJar

output jar lands in build/libs/. the one without -dev in the name is the one you want.

run a dev client (for testing):

./gradlew runClient

generate IDE sources (IntelliJ / Eclipse):

./gradlew genSources

then import as a Gradle project. IntelliJ will figure it out.


Project Structure

src/
├── main/resources/          # mod metadata, mixins config, assets
└── client/java/com/helium/
    ├── HeliumClient.java    # entrypoint
    ├── config/              # config loading/saving + YACL screen
    ├── compat/              # sodium config integration, modmenu
    ├── data/                # custom data structures
    ├── memory/              # object pools, buffer pools
    ├── render/              # GL state cache, block entity culling
    └── mixin/
        ├── math/            # fast math replacements
        ├── render/          # entity/block entity culling, GL state
        ├── particle/        # particle distance culling
        ├── tick/            # client world tick optimizations
        ├── network/         # network buffer optimizations
        └── multiplayer/     # server list pinging, scroll preservation

Dependencies

Dependency Type Why
Fabric API Required you know why
Sodium Required config UI lives inside sodium's settings
YACL Embedded powers the ModMenu config screen
ModMenu Optional adds the mod toggle in the mod list

Contributing

PRs welcome. if you're fixing a bug, please describe what was broken and why. if you're adding a feature, open an issue first so we don't waste each other's time.

the codebase uses Yarn mappings and targets Minecraft 1.21.x with Fabric Loader 0.16+.

fair warning: the mixin naming convention uses helium$ prefix for all injected methods. keep it consistent.


License

MIT do whatever you want with it.

About

Client-side performance mod for Minecraft. Cuts out the stuff your GPU shouldn't be wasting time on.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors

Languages