Skip to content

WIP: A fork of Flywheel with changes to test Iris compatibility with the instancing backend. Not intended for production use.

License

Notifications You must be signed in to change notification settings

IrisShaders/Flywheel-Iris-Instancing

 
 

Repository files navigation

Logo by @voxel_dani on Twitter

Flywheel

A modern engine for modded Minecraft.
Jenkins Discord Curseforge Downloads

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 {
    modImplementation "com.jozufozu.flywheel:Flywheel-Fabric:${flywheel_version}"
}

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

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

About

WIP: A fork of Flywheel with changes to test Iris compatibility with the instancing backend. Not intended for production use.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 99.9%
  • Other 0.1%