Flywheel mirror in case github ever goes down
Find a file
Jozufozu 8a4d319d8d Fog so thick you could cut it
- Add generic ResourceLocation Index in ShaderIndices.
- Add FogShader and CutoutShader API.
- Implement existing fog/cutout configurations as separate shaders.
- Simplify pipeline shaders to accommodate for new api.
- Separate fog and cutout ubershader components.
  - This was much easier than I anticipated, seems we finally have a
    usable compiler/shader stitcher.
- Pass fog and cutout IDs to ubershader via a 2x16 packed uint.
- Remove discardPredicate and fogFilter from default material shader.
2023-12-02 13:08:25 -08:00
.github Instance Refactor I 2023-04-04 12:36:54 -07:00
gradle/wrapper Build system but no build 2023-11-22 20:57:46 -08:00
src Fog so thick you could cut it 2023-12-02 13:08:25 -08:00
.editorconfig
.gitattributes
.gitignore Full of red flags 2023-11-18 16:07:58 -08:00
build.gradle Port fixes and other changes 2023-11-25 14:09:30 -08:00
changelog.txt
gradle.properties Instant backport 2023-11-23 22:45:39 -08:00
gradlew Build system but no build 2023-11-22 20:57:46 -08:00
gradlew.bat Build system but no build 2023-11-22 20:57:46 -08:00
LICENSE.md Housekeeping 2023-05-21 15:24:33 -07:00
README.md
settings.gradle Build system but no build 2023-11-22 20:57:46 -08:00

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 {
    implementation fg.deobf("com.jozufozu.flywheel:Flywheel-Forge:${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.

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.