Flywheel mirror in case github ever goes down
Go to file
PepperCode1 2f7fce29c3 Arrays and alignment
- Allow array elements in layouts with lengths in range [1, 256]
- Align each layout element to its primitive size instead of always
aligning to 4 bytes; this is the same as C struct alignment
- Rename package lib.visual.components -> component
- Add more methods to layout API interfaces to allow retrieving
information such as padding size and alignment
2024-04-05 17:00:04 -07:00
.github
.idea
docs/shader-api
gradle
src Arrays and alignment 2024-04-05 17:00:04 -07:00
.editorconfig
.gitattributes
.gitignore
build.gradle 24w13oneSectionAtATime 2024-03-25 11:26:36 -05:00
changelog.txt
gradle.properties
gradlew
gradlew.bat
LICENSE.md
README.md
settings.gradle

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.