Flywheel mirror in case github ever goes down
Go to file
Jozufozu dfca589c5b Boundless changes
- Fix exception thrown uploading indirect instances when an instance was
  added in the same frame that the tail instance was deleted. We'd leave
  behind some set changed bits out of bounds of the instance list, and
  try to access those indices later
- Add out of bounds guards within forEachSetSpan, though I don't think
  they're actually necessary
- Add AtomicBitset#set and #clear range methods
- Update all changed bits at once when deleting instances rather than
  doing it in the loop
- Start iterating from the first set bit rather than 0 to save
  potentially thousands of iterations
- Smarter model index uploading
2024-03-31 12:56:01 -07:00
.github
.idea
docs/shader-api A sample of what's to come 2024-02-26 15:38:11 -08:00
gradle Automated nullability 2024-01-22 11:12:48 -08:00
src Boundless changes 2024-03-31 12:56:01 -07:00
.editorconfig
.gitattributes
.gitignore Automated nullability 2024-01-22 11:12:48 -08:00
build.gradle 24w13oneSectionAtATime 2024-03-25 11:26:36 -05:00
changelog.txt
gradle.properties Automated nullability 2024-01-22 11:12:48 -08:00
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.