Flywheel mirror in case github ever goes down
Find a file
Jozufozu c438fb57ca Atomic fusion before Flywheel 1.0
- Add workaround for race condition flipping the "mergeable" bit for
  instance pages
- Sometimes a page would end up full while another thread was racing to
  set the mergeable bit, so when we later tried to merge pages we'd get
  an array index out of bounds
- This change makes it so we only ever set the mergeable bit and handle
  the case of a full page when trying to merge
- Should also help us avoid the alternative case where a page that is
  actually mergeable isn't marked as such
2025-02-15 15:51:30 -08:00
.github Hrm 2025-01-12 16:23:34 -08:00
.idea Lookin good 2024-12-24 17:22:32 -08:00
buildSrc Gradle is always so extra 2025-01-26 17:20:24 -08:00
common Atomic fusion before Flywheel 1.0 2025-02-15 15:51:30 -08:00
docs/shader-api Nobody Else Shall Wonder 2025-01-05 11:19:06 -08:00
fabric Is this thing on? 2025-01-25 10:37:46 -06:00
forge Vanillinization 2025-01-23 12:14:01 -06:00
gradle/wrapper Backport changes from 1.21.1 (#265) 2024-10-18 20:29:43 -07:00
vanillinFabric Suddenly: mod compat 2025-01-24 11:49:59 -06:00
vanillinForge Suddenly: mod compat 2025-01-24 11:49:59 -06:00
.editorconfig Automated testing (#269) 2024-11-03 17:57:47 -08:00
.gitattributes Squish 2024-03-07 19:08:15 -08:00
.gitignore fix loom version getting (#254) 2024-09-09 19:11:05 -07:00
build.gradle.kts Wait, it's all kotlin? 2024-05-17 08:43:56 -07:00
gradle.properties Moving maven 2025-01-26 14:48:58 -08:00
gradlew Backport changes from 1.21.1 (#265) 2024-10-18 20:29:43 -07:00
gradlew.bat Backport changes from 1.21.1 (#265) 2024-10-18 20:29:43 -07:00
javadoc-options.txt Use central javadoc-options file 2024-05-17 08:43:56 -07:00
Jenkinsfile There's always another secret 2025-01-26 17:09:37 -08:00
LICENSE.md All your script are belong to us 2024-05-17 08:43:56 -07:00
README.md Does anyone read this? 2025-01-26 17:55:02 -08:00
settings.gradle.kts Add foojay resolver 2025-01-21 17:23:56 -06:00

Logo by jnix

Flywheel

Reinventing the wheel so you don't have to.
Jenkins License
Discord Curseforge Downloads Modrinth

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 block entity rendering that takes advantage of GPU instancing. Flywheel gives the developer the flexibility to define their instance formats and write custom shaders to ingest that data.

To accommodate 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.

Getting Started (For Developers)

Add the following repo and dependency to your build.gradle:

repositories {
    maven {
        name "createmod maven"
        url "https://maven.createmod.net/"
    }
}

dependencies {
    // On forge
    compileOnly fg.deobf("dev.engine-room.flywheel:flywheel-forge-api-${minecraft_version}:${flywheel_version}")
    runtimeOnly fg.deobf("dev.engine-room.flywheel:flywheel-forge-${minecraft_version}:${flywheel_version}")

    // With loom
    modApi "dev.engine-room.flywheel:flywheel-fabric-api-${minecraft_version}:${flywheel_version}"
    modImplementation "dev.engine-room.flywheel:flywheel-fabric-${minecraft_version}:${flywheel_version}"
}

${flywheel_version} gets replaced by the version of Flywheel you want to use, eg. 1.0.0-beta

${minecraft_version} gets replaced by the version of Minecraft you're on, eg. 1.20.1

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.