Flywheel

A modern engine for modded Minecraft.

About

The goal of this project is to provide tools for mod developers so they no longer have to worry about performance, or limitations of Minecraft's archaic rendering engine. That said, this is primarily an outlet for me to have fun with graphics programming.

Instancing

Flywheel provides an alternate, unified path for entity and tile entity rendering that takes advantage of GPU instancing. In doing so, Flywheel gives the developer the flexibility to define their own vertex and instance formats, and write custom shaders to ingest that data.

Shaders

To accomodate the developer and leave more in the hands of the engine, Flywheel provides a custom shader loading and templating system to hide the details of the CPU/GPU interface. This system is a work in progress. There will be breaking changes, and I make no guarantees of backwards compatibility.

Plans

Vanilla performance improvements
Compute shader particles
Deferred rendering
Different renderers for differently aged hardware

Getting Started (For Developers)

Add the following repo and dependency to your build.gradle:

repositories {
    maven {
        name "tterrag maven"
        url "https://maven.tterrag.com/"
    }
}

dependencies {
    compileOnly fg.deobf("dev.engine_room.flywheel:flywheel-forge-api-${minecraft_version}:${flywheel_version}")
    runtimeOnly fg.deobf("dev.engine_room.flywheel:flywheel-forge-${minecraft_version}:${flywheel_version}")
}

${flywheel_version} gets replaced by the version of Flywheel you want to use, eg. 1.0.0-beta

${minecraft_version} gets replaced by the version of Minecraft you're on, eg. 1.20.1

For a list of available Flywheel versions, you can check the maven.

If you aren't using mixed mappings (or just want to be safe), add the following properties to your run configurations:

property 'mixin.env.remapRefMap', 'true'
property 'mixin.env.refMapRemappingFile', "${projectDir}/build/createSrgToMcp/output.srg"

This ensures that Flywheel's mixins get properly loaded in your dev env.

Engine-Room / Flywheel

readme