Flywheel mirror in case github ever goes down
Find a file
Jozufozu 8126a63216 Full of red flags
- Add concept of flags to TaskExecutor.
- Can raise and lower flags from any thread.
- Add TaskExecutor#syncTo
  - Behaves much like #syncPoint, but exits early as soon as it detects
    that the requested flag has been raised.
- Document all methods in TaskExecutor.
- Do not discard tasks when destroying a VisualizationManagerImpl.
- Use flags in VisualizationManagerImpl to track frame plan and tick
  plan completion.
- Use flags in BatchingEngine to track stage buffering completion and
  flush completion.
  - Synchronization is now needed in BatchedDrawTracker#draw.
- Use flags in IndirectEngine and InstancingEngine to track flush
  completion.
- Add unit tests to validate flag behavior.
- Rename OnMainThreadPlan -> SyncedPlan.
2023-11-18 16:07:58 -08:00
.github Instance Refactor I 2023-04-04 12:36:54 -07:00
gradle/wrapper Scheme-a-version 2022-07-15 00:00:54 -07:00
src Full of red flags 2023-11-18 16:07:58 -08:00
.editorconfig Merge branch '1.18/dev' into 1.18/next 2023-03-28 13:22:53 -07:00
.gitattributes
.gitignore Full of red flags 2023-11-18 16:07:58 -08:00
build.gradle Sweeping changes 2023-11-18 11:46:04 -08:00
changelog.txt Update changelog.txt 2022-12-14 09:16:21 -08:00
gradle.properties Housekeeping 2023-05-21 15:24:33 -07:00
gradlew Scheme-a-version 2022-07-15 00:00:54 -07:00
gradlew.bat
LICENSE.md Housekeeping 2023-05-21 15:24:33 -07:00
README.md Sweeping up 2021-12-14 22:00:44 -08:00
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.