Flywheel mirror in case github ever goes down
Go to file
Jozufozu 44b9a666c4 Resolved to ashes
- FileResolution was implemented to support a two-pass
  preprocessor/compiler.
- The new architecture no longer needs its functionality.
- It doesn't make sense to have implementors individually apply the
  "checks" to ensure their components are sound.
- The component checking code
- Remove FileResolution, replace all references with ResourceLocation
- Small refactor to UniformBuffer to put everything into one UBO
- Remove BlockEntityRenderDispatcherAccessor
- Rename component resource location getters for consistency
- Small cleanups here and there
- Consolidate SourceChecks to SourceChecks.java for future use
2023-03-26 00:39:35 -07:00
.github Merge branch '1.18/dev' into 1.18/next 2022-08-16 10:48:46 -07:00
gradle/wrapper Scheme-a-version 2022-07-15 00:00:54 -07:00
src/main Resolved to ashes 2023-03-26 00:39:35 -07:00
.editorconfig Indirectly packed 2022-08-21 16:47:15 -07:00
.gitattributes
.gitignore Reduce merge conflicts with shader-sanity 2022-01-07 11:50:01 -08:00
build.gradle Merge branch '1.18/culling' into 1.18/next 2022-08-22 17:18:13 -07:00
changelog.txt Update changelog and bug report template 2022-07-11 20:55:01 -04:00
gradle.properties Merge branch '1.18/dev' into 1.18/next 2022-08-16 10:48:46 -07:00
gradlew Scheme-a-version 2022-07-15 00:00:54 -07:00
gradlew.bat
LICENSE.md Final fix-ups 2022-07-15 19:29:42 -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.