diff --git a/README.md b/README.md index 95d7ba6ba..82d4ede4b 100644 --- a/README.md +++ b/README.md @@ -46,10 +46,12 @@ repositories { } dependencies { - implementation fg.deobf("com.jozufozu.flywheel:Flywheel-Forge:${flywheel_version}") + compileOnly fg.deobf("com.jozufozu.flywheel:flywheel-forge-api-${minecraft_version}:${flywheel_version}") + runtimeOnly fg.deobf("com.jozufozu.flywheel:flywheel-forge-${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. `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](https://maven.tterrag.com/com/jozufozu/flywheel/Flywheel-Forge/). diff --git a/changelog.txt b/changelog.txt deleted file mode 100644 index 9ccbe5e24..000000000 --- a/changelog.txt +++ /dev/null @@ -1,115 +0,0 @@ -0.6.8: -Fixes - - Fix colored vertices being incorrectly rendered through instancing - - Fix some miscellaneous bugs with sodium/rubidium - - Fix memory leak associated with model storage -Technical/API - - Memory for models is freed when they are no longer in use - - Element buffers now deal in raw gl handles - - Element buffers are no longer considered part of state resoration - - Quad -> Tri element buffer properly resets itself - -0.6.7: -...is 1.19 only :ioa: - -0.6.6: -Fixes - - Fix instanced entities not rendering correctly when chunk loading is slow -Technical/API - - GL state is more reliably managed - - Slight memory improvements when using Iris/Oculus through lazy instatiation - -0.6.5: -Fixes - - Fix crash with batching backend and Rubidium - -0.6.4: -Fixes - - Fix shader detection with oculus -Technical/API - - LightUpdater is simplified to increase reliability and reflect how it is actually used - - ModelUtil is superseded by model builders, to be improved more in 0.7.0 - - VertexLists now copy input buffers to reduce memory usage - -0.6.3: -Technical/API - - Light updates are now processed in parallel. - - The light updater is now more selective of the levels it processes, fixing a memory leak. - -0.6.2: -Update to 1.18.2 - -0.6.1: -Fixes -- Fix crash when loading block entities for Flywheel to render, most common when exploring the end. -- Fix occasional visual artifacts when enabling optifine shaders. -Technical/API -- Added more debug information to the F3 screen. -- Distance update limiting can now be disabled. - -0.6.0: -With this release, Flywheel is no longer needed on servers! Forge finally has client commands, -and the /flywheel command now takes advantage of this. -Fixes - - Fix crash when running with sodium/magnesium. -Technical/API - - Backend is now a static class. - - Shaders are now compiled on-the-fly and cached. - - Significantly reduced the amount of boilerplate needed in instancing shaders. - - Struct types no longer need to be registered ahead of time. - - Simplify unnecessarily complicated game state system. - -0.5.1: -Fixes - - Fix crash on resource reload with backend off - - Fix artifacts while using Optifine shaders - - Fix crash when trying to access biomes in a VirtualRenderWorld -Technical/API - - Refactor instance renderer registration to separate client and server logic (thanks Pepper!) - - VirtualRenderWorlds now have a "biomeOffset" field which gets added when looking up biomes - - Added GlStateTracker which hooks into GlStateManager to track changes in buffer, vertex array, and program bindings - -0.5.0a: -Fixes - - Address crash experienced by some users while rendering any tile. - - Fix crash caused by loading a world with flywheel backend off. - -0.5.0: -New - - Added parallel batching backend, effectively a CPU instancer. - - Now partially compatible with starlight. -Technical/API - - Much more flexible vertex formats. - - Do instance updates/ticking entirely async. - -0.4.2-rc: -Fixes - - Partially fix crash on intel and mesa drivers (needs Create to update) - - Fix garbage rendering on AMD GPUs - -0.4.1: -Update to 1.18.1 -Changes - - Use cylindrical fog to match vanilla -Fixes - - Fix crash affecting systems that don't support persistent mapping - - Fix crash when Create contraptions extend below Y=0 - - Fix Create contraptions having misaligned light when launched after world load - - Fix minecarts disappearing on chunk reload - -0.4.0: -Update to 1.18 -Fixes - - Fix potential nullpointer rendering breaking overlay - - Fix inconsistency in minecart model - - Fix memory leak when instance worlds get reset -Technical/API - - No more MaterialSpec, everything is StructType - - Move most user facing interfaces to flywheel.api package - - Refactor InstanceData to have no package private fields - - Rename many interfaces - - All materials use the same vertex format: UNLIT_MODEL - - call #tick and #beginFrame on instance creation - - Fixes weird delay in object appearance when reloading chunks - - Add instances when chunks are built for rendering - - Server worlds are not flywheel worlds diff --git a/gradle.properties b/gradle.properties index 0f45aed79..3b9b3881f 100644 --- a/gradle.properties +++ b/gradle.properties @@ -4,7 +4,7 @@ org.gradle.daemon = false # Mod metadata mod_id = flywheel mod_name = Flywheel -mod_version = 1.0.0-alpha +mod_version = 1.0.0-beta mod_description = An overhauled entity and block entity rendering API. mod_license = MIT mod_sources = https://github.com/Jozufozu/Flywheel @@ -37,8 +37,3 @@ oculus_version = 1.20.1-1.6.15a # Publication info artifact_minecraft_version = 1.20.1 - -#forgegradle_version = [6.0.16,6.2) -#mixingradle_version = 0.7.+ -#mixin_version = 0.8.5 -#librarian_version = 1.+