diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3dbe6f0b0..7ef4717ff 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -59,6 +59,7 @@ body: label: Mod Version description: The version of the mod you were using when the bug occured options: + - "0.6.9" - "0.6.8.a" - "0.6.8" - "0.6.7" @@ -94,6 +95,7 @@ body: label: Minecraft Version description: The version of Minecraft you were using when the bug occured options: + - "1.20.1" - "1.19.2" - "1.18.2" - "1.18.1" diff --git a/README.md b/README.md index 95d7ba6ba..3764cc92d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@
-Logo by @voxel_dani on Twitter -

Flywheel

-
A modern engine for modded Minecraft.
-Jenkins -Discord -Curseforge Downloads -
+ Logo by @voxel_dani on Twitter +

Flywheel

+
A modern engine for modded Minecraft.
+ Jenkins + License + Discord + Curseforge Downloads + Modrinth +

### About @@ -22,7 +24,7 @@ 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 +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. This system is a work in progress. There will be breaking changes, and I make no guarantees of backwards compatibility. @@ -46,14 +48,15 @@ repositories { } dependencies { - implementation fg.deobf("com.jozufozu.flywheel:Flywheel-Forge:${flywheel_version}") + implementation fg.deobf("com.jozufozu.flywheel:flywheel-forge-${flywheel_minecraft_version}:${flywheel_version}") } ``` -`${flywheel_version}` gets replaced by the version of Flywheel you want to use, eg. `1.18-0.3.0.3` +`${flywheel_version}` gets replaced by the version of Flywheel you want to use, eg. `0.6.9`. +`${flywheel_minecraft_version}` gets replaced by the version of Minecraft, eg. `1.18.2`. -For a list of available Flywheel versions, you can check [the maven](https://maven.tterrag.com/com/jozufozu/flywheel/Flywheel-Forge/). +For a list of available Flywheel versions, you can check [the maven](https://maven.tterrag.com/com/jozufozu/flywheel/). -If you aren't using mixed mappings (or just want to be safe), add the following properties to your run configurations: +If you aren't using Mojang mappings (or just want to be safe), add the following properties to your run configurations: ```groovy property 'mixin.env.remapRefMap', 'true' property 'mixin.env.refMapRemappingFile', "${projectDir}/build/createSrgToMcp/output.srg"