Skip to content

About

Minecraft mod that provides efficient BaseMapCodec.decode implementation

Resources

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation

fastmapcodec

Fixes TPS freeze on player join caused by large advancement files (and the same class of freeze anywhere else in the game, or in other mods, that decodes a large map through DFU).

Fixes O(N²) behavior in Mojang's BaseMapCodec (part of com.mojang:datafixerupper) when decoding large map-based Codecs. Since the fix lives in BaseMapCodec itself, it applies to every codec built on top of it - UnboundedMapCodec, SimpleMapCodec, and anything else sharing the same decode/encode logic - not just player advancements.

Versions affected: 1.21 and higher.

Upstream PR: Mojang/DataFixerUpper#110 Benchmarks: nekotxs/BaseMapCodec-bench

Background

Since e0b245e, BaseMapCodec.decode() accumulates entries into an Object2ObjectArrayMap, which does a linear scan on every insert - O(N²) total for N entries. Fine for the small maps that make up most Codec usage in vanilla, but nothing bounds N, and large player-controlled data (e.g. a heavily modded advancement tree) can push it into the tens of thousands, costing seconds of main-thread freeze on join.

In my case, it caused 10–15 seconds of server lag each time anyone joined a moderately modded NeoForge server.

The fix: try ImmutableMap.Builder.buildOrThrow() first (fastest at every N in benchmarks); on failure (duplicate key - rare, ~0.004% of calls on a modded server, unobserved on vanilla), fall back to Object2ObjectOpenHashMap to recover partial results. Preserves the original duplicate-key / partial-error-handling semantics. Full methodology and comparison against alternatives in the bench repo linked above.

Building

./gradlew neoforge:build   # neoforge/build/libs/
./gradlew fabric:build     # fabric/build/libs/

Automated testing

version-matrix-test.yml builds the mod once and spins up real, ephemeral NeoForge and Fabric servers across the full supported Minecraft version range (1.21 through 26.2) to verify:

  • the mod is discovered and loads correctly on both pre- and post-consolidation NeoForge loader generations
  • datafixerupper is successfully made transformable by Mixin
  • BaseMapCodec is patched

Runs automatically on every push to main and on pull requests. Contributors can also trigger it manually from the Actions tab (Version Matrix Test → Run workflow) to check their own branch before opening a PR.

By running these tests, you accept the Minecraft EULA on behalf of each ephemeral server they launch. These servers run for under two minutes, never accept player connections, and are destroyed immediately after each test run.

License / attribution

The decode() implementation adapts code from com.mojang.serialization.codecs.BaseMapCodec in Mojang/DataFixerUpper, MIT-licensed.

neoforge/src/main/java/.../service/ModuleLayerMigrator.java, FastMapCodecModLocator.java, and ConnectorUtil.java adapt code from SinytraConnector, MIT-licensed.

About

Minecraft mod that provides efficient BaseMapCodec.decode implementation

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages