squaremap

Changelog

Performance

Full renders are faster on Paper, and on Fabric and NeoForge with [Moonrise](https://modrinth.com/mod/moonrise-opt). In our benchmark, a full render took 41.50 s instead of 64.72 s, a 1.56× speedup (Ryzen 9 5950X, 1,495,729 chunks). (#615, #616)  - Remove lock contention when writing rendered pixels (#616) Without Moonrise, render speed is limited by Minecraft's own chunk I/O, so these changes don't make renders faster there. For the fastest renders on Fabric and NeoForge, install Moonrise.

Fixed

- Fabric, NeoForge and Sponge without Moonrise: fix renders stalling the server thread while waiting for chunks to be read from disk, causing lag during renders. Present since squaremap 1.1.0. Render speed is unchanged

Changelog

Changed

- Hide bush, short dry grass, and tall dry grass by default, like short grass. Existing configs get them in every invisible-blocks list that still hides short grass - Tint leaf litter with the biome's dry foliage color, like vanilla, instead of its brown map color. Adds a color-overrides.biomes.dry-foliage setting - Tint bush with the biome grass color and give dry grass a tan color, for configs that show them - Add default color overrides for torchflower, pitcher plant, wildflowers, and golden dandelion. Existing configs get them without changing values you've set - Update dependencies Forests, deserts, and badlands look noticeably different. Existing tiles only change as chunks re-render; run /squaremap fullrender <world> to update the whole map.

Changelog

Changed

- Hide bush, short dry grass, and tall dry grass by default, like short grass. Existing configs get them in every invisible-blocks list that still hides short grass - Tint leaf litter with the biome's dry foliage color, like vanilla, instead of its brown map color. Adds a color-overrides.biomes.dry-foliage setting - Tint bush with the biome grass color and give dry grass a tan color, for configs that show them - Add default color overrides for torchflower, pitcher plant, wildflowers, and golden dandelion. Existing configs get them without changing values you've set - Update dependencies Forests, deserts, and badlands look noticeably different. Existing tiles only change as chunks re-render; run /squaremap fullrender <world> to update the whole map.

Changelog

Performance

Full renders are much faster. In our benchmark with default settings, a full render on Paper took 14.03 s instead of 38.59 s, a 2.75× speedup, using half as many render workers and producing identical output (Ryzen 9 5950X, 288,369 chunks, Minecraft 26.3). (#601, #610)  - Read unloaded chunks directly from region files off the main thread on Paper, and on Fabric and NeoForge with the [Moonrise](https://modrinth.com/mod/moonrise-opt) mod installed (recommended) (#601) - Skip biome blending when every position in the blend window is the same biome <details> <summary>Breakdown: renderer rewrite vs. direct snapshot loading</summary> On its own, the renderer rewrite is 1.21× faster without direct snapshot loading and 1.48× faster with it. ![Full render times with and without direct snapshots](https://github.com/user-attachments/assets/f167eb19-22fc-… </details>

Changed

- Render settings are now set per render mode under map.render.<full|radius|background>, and image saving is configured under map.image-saving. Existing configs are migrated automatically (config version 3) - Default render worker counts are lower on machines with more than 8 threads. Configs using the old automatic default (-1) migrate to default and get the new counts - The default max-chunks-per-interval for background renders is raised from 1024 to 2048. Configs still set to 1024 are migrated to 2048; other values are kept - Radius renders now resume after a restart, like full renders; resumed renders skip chunks that are no longer visible - Visibility limits, the world border and render settings are captured when a render starts - Queued image saves are always completed at shutdown instead of being dropped after 5 seconds - Region scanning log messages now name the world, and image read/save errors name the file; the could-not-*-region locale keys are now could-not-*-image - Removed squaremap-client support - Mark [Moonrise](https://modrinth.com/mod/moonrise-opt) versions older than 1.0.1 as incompatible on Fabric and NeoForge (Moonrise is still optional) - Update dependencies

Fixed

- Fix world configs retaining worlds unloaded at runtime #600 - Fix partially upgraded terrain being rendered for retrogen chunks (#601) - Fix terrain shading next to fluids (#604) - Fix inconsistent shading across chunk and region boundaries in all render types - Fix the first run limiting rendering to the world border even though the generated config showed the limit as disabled - Fix full renders failing for dimensions that have never saved a chunk - Fix /squaremap resetmap leaving tiles from in-progress renders and queued image saves in the reset map. It now refuses to run while a full or radius render is in progress - Fix markers.json and other web files not being rewritten after a map reset when using an external web server - Fix unreadable render progress being warned about on every startup - Fix background renders losing claimed chunks in some cases, such as when stopped while planning - Fix progress logging: the ETA no longer wraps after 24 hours, a final line is logged when a render ends, and re-enabling logging mid-render works - Sponge: fix commands failing to register

Changelog

Performance

Full renders are much faster. In our benchmark with default settings, a full render on Paper took 14.03 s instead of 38.59 s, a 2.75× speedup, using half as many render workers and producing identical output (Ryzen 9 5950X, 288,369 chunks). (#601, #610)  - Read unloaded chunks directly from region files off the main thread on Paper, and on Fabric and NeoForge with the [Moonrise](https://modrinth.com/mod/moonrise-opt) mod installed (recommended) (#601) - Skip biome blending when every position in the blend window is the same biome <details> <summary>Breakdown: renderer rewrite vs. direct snapshot loading</summary> On its own, the renderer rewrite is 1.21× faster without direct snapshot loading and 1.48× faster with it. ![Full render times with and without direct snapshots](https://github.com/user-attachments/assets/f167eb19-22fc-… </details>

Changed

- Render settings are now set per render mode under map.render.<full|radius|background>, and image saving is configured under map.image-saving. Existing configs are migrated automatically (config version 3) - Default render worker counts are lower on machines with more than 8 threads. Configs using the old automatic default (-1) migrate to default and get the new counts - The default max-chunks-per-interval for background renders is raised from 1024 to 2048. Configs still set to 1024 are migrated to 2048; other values are kept - Radius renders now resume after a restart, like full renders; resumed renders skip chunks that are no longer visible - Visibility limits, the world border and render settings are captured when a render starts - Queued image saves are always completed at shutdown instead of being dropped after 5 seconds - Region scanning log messages now name the world, and image read/save errors name the file; the could-not-*-region locale keys are now could-not-*-image - Removed squaremap-client support - Update dependencies

Fixed

- Fix world configs retaining worlds unloaded at runtime #600 - Fix partially upgraded terrain being rendered for retrogen chunks (#601) - Fix terrain shading next to fluids (#604) - Fix inconsistent shading across chunk and region boundaries in all render types - Fix the first run limiting rendering to the world border even though the generated config showed the limit as disabled - Fix full renders failing for dimensions that have never saved a chunk - Fix /squaremap resetmap leaving tiles from in-progress renders and queued image saves in the reset map. It now refuses to run while a full or radius render is in progress - Fix markers.json and other web files not being rewritten after a map reset when using an external web server - Fix unreadable render progress being warned about on every startup - Fix background renders losing claimed chunks in some cases, such as when stopped while planning - Fix progress logging: the ETA no longer wraps after 24 hours, a final line is logged when a render ends, and re-enabling logging mid-render works - NeoForge: fix modded fluid color export on current NeoForge 26.3 builds - Sponge: fix compatibility with Sponge 26.3 (now built against API 21) - Sponge: fix commands failing to register

## Changelog ### Changed - Align NeoForge shutdown lifecycle with Fabric - Update dependencies ### Fixed - Fix incorrect grass and foliage colors caused by a nondeterministic biome downfall lookup #290 (#578) - Fix crash caused by fluids with no tint source, a regression from the Minecraft 26.1 update #588 - Fix mobile viewport height so browser chrome does not obscure the bottom controls #561 - Fix invalid map markers and missing sidebar entries for players without position data

## Changelog ### Changed - Update for Minecraft 26.3 - Update dependencies ### Fixed - Fix randomly incorrect grass and foliage colors (savanna and others) caused by a nondeterministic biome downfall lookup #290 (#578) - Fix crash caused by fluids with no tint source, a regression from the Minecraft 26.1 update #588 - Web: use dynamic viewport height so mobile browser chrome no longer obscures the bottom controls #561 - Web: handle players without position data (no more invalid map markers; they remain listed in the sidebar)

Changelog

Changed

- Use Modrinth for update checks to only recommend releases for the current Minecraft version

Fixed

- Adapt to NeoForge's BreakBlockEvent API change (#568) - Fix NeoForge block updates for multi-place events

Changelog

Changed

- Use Modrinth for update checks to only recommend releases for the current Minecraft version - Align NeoForge shutdown lifecycle with Fabric - Update dependencies

Changelog

Changed

- Update for Minecraft 26.2

## Changelog ### Changed - Update for Minecraft 26.1.2 ### Fixed - Error with framed blocks #514

## Changelog ### Fixed - Error sending commands on Fabric and NeoForge #501

## Changelog ### Fixed - Error joining world on Fabric #500

## Changelog ### Changed - Update for Minecraft 1.21.11

## Changelog ### Changed - Update for Minecraft 1.21.10 - Update pt-br locale (#406)

## Changelog ### Changed - Update for Minecraft 1.21.8 ### Fixed - UILink initialization order ([#441](https://github.com/jpenilla/squaremap/issues/441))

## Changelog ### Changed - Update for Minecraft 1.21.7 ([#422](https://github.com/jpenilla/squaremap/pull/422)) ([#430](https://github.com/jpenilla/squaremap/pull/430))

## Changelog ### Changed - build: Use resource-factory to generate plugin/mod metadata ### Fixed - web: Fix asset paths for subdirectory hosting ([#411](https://github.com/jpenilla/squaremap/pull/411))

## Changelog ### Added - /map link command (implements https://github.com/jpenilla/squaremap/issues/120) - configure with settings.web-address in config.yml and in the locale file - web: Disable certain updates when static is true in the root settings.json, useful for non-changing map deployments like [the demo](https://squaremap-demo.jpenilla.xyz) (https://github.com/jpenilla/squaremap/pull/393) - web: Copy URL to clipboard automatically when clicking link button ### Changed - Update for Minecraft 1.21.5 - Write markers to disk less often when immediate flushing is disabled - web: Don't update the URL until clicking the link button - web: Convert frontend to Vite project ([#400](https://github.com/jpenilla/squaremap/pull/400)) ### Fixed - web: Rotate player markers in the correct direction when passing due-north orientation (https://github.com/jpenilla/squaremap/pull/357) - web: Unable to close sidebar on mobile (now closed by tapping outside the sidebar when unpinned) - web: Fixed player markers flickering on update on some browsers - web: Player nameplate alignment with health/armor disabled (https://github.com/jpenilla/squaremap/issues/31) - web: Inconsistent behavior when following players - ETags for player and marker updates

## Changelog ### Changed - Update for Minecraft 1.21.4 - Update for Paper hard fork and Moonrise changes

## Changelog ### Added - Brazilian Portuguese translation (#320) - Hide players wearing items tagged with MAP_INVISIBILITY_EQUIPMENT (#305) ### Changed - Update for Minecraft 1.21.3 (#322) ### Fixed - Set player head marker size to be fixed size. (#332)

## Changelog ### Fixed - Render not loading chunks with [Moonrise](https://modrinth.com/mod/moonrise-opt) ### Changed - Simplified the PaperChunkSnapshotProvider

## Changelog ### Fixed - [Moonrise](https://modrinth.com/mod/moonrise-opt) compatibility on Fabric

## Changelog ### Added - Support for [Moonrise](https://modrinth.com/mod/moonrise-opt) on Fabric and NeoForge (#283) - Include y coordinate in player position (#200) - Added options to hide certain elements within the URL Params (#315) These options persist when copying a link to the map using the link button; see #319 - show_sidebar=false - Hides the world sidebar on the right - show_coordinates=false - Hides coordinates display in bottom left - show_link_button=false - Hides link button in bottom left - show_controls=false - Hides Leaflet controls ### Changed - Use atomic writes for render progress and dirty chunks - Avoid writing player data to disk when possible (#245)

## Changelog ### Changed - Update for Minecraft 1.21.1 - folia: Use API to check if chunk is owned by current thread

## Changelog ### Changed - Updated dependencies - paper: Updated for chunk system changes

## Changelog ### Changed - Update for Minecraft 1.21 (#239)

## Changelog ### Changed - Update for Minecraft 1.20.6 (#212) - web: display block coordinates in Leaflet (#170) - Update Cloud to v2 (#165) ### Fixed - web: Fix error handling for missing tiles & make error tiles invisible (#205, 01a9ca2dae7ad85befca50a682a144b1c9b76446)

## Changelog ### Changed - Update for Minecraft 1.20.4 (#150) ### Fixed - web map: Following players through dimensions (#145) - web map: Following players through respawn or reconnect

## Changelog ### Added - [NeoForge](https://neoforged.net/) support - Count .linear region files for full renders

Changelog

Changed

- Update for Minecraft 1.20.2 - Don't delete icons on unregister (#115) - Consider below zero retrogen target status for chunk generated check (#117) - Allows pre-1.18 chunks to be rendered without being re-upgraded to full status

Fixed

- forge: Missing include for plain adventure serializer (#118)

Where are Forge builds?

- Starting with 1.20.2, squaremap will drop support for [MinecraftForge](https://github.com/MinecraftForge/MinecraftForge) and will instead support [NeoForge](https://github.com/neoforged/NeoForge). Once NeoForge is available for 1.20.2 squaremap-forge will be updated to support it.

Changelog

Added

- API: HtmlComponentSerializer and HtmlStripper (#112) - Polygon visibility limit config (see the visibility-limits section on the [config.yml wiki page](https://github.com/jpenilla/squaremap/wiki/Default-config… for an example)

Changed

- Skip writing players, markers, and world settings to disk when nothing has changed - paper: Plugin now loads at STARTUP, allows more flexibility for addon authors

Fixed

- Regions getting wrongly skipped in full renders when the spawn point is not in region 0,0

Changelog

Fixed

- Player update task run in wrong thread context on Paper #109

Changelog

Added

- paper: Folia support - Default color overrides for minecraft:pink_petals block (#FFB4DB) and minecraft:mangrove_swamp biome (#6F9623) to advanced.yml - Existing configs will have the new overrides added automatically when updating

Changed

- enabled boolean option now works for all types of visibility limits in the config, not just world-border - defaults to true when not set explicitly

Fixed

- Exception when tab completing world key with empty path - Handling of mangrove leaves - Sponge platform - fabric: Incompatibilities with some mods due to outdated bundled adventure-platform-fabric snapshot

Changelog

Added

- paper: PlayerChunkLoadEvent map update listener (default off)

Changed

- Update for Minecraft 1.20.1

Changelog

Fixed

- paper: Fullrender would cause empty chunks to save to disk since chunk system rewrite (b51e1d2)

Changed

- forge: Remove ChunkHolderMixin in favor of new ChunkEvent.Load#isNewChunk API

Changelog

Fixed

- Formatting issue in Russian translation file

Changed

- Update for Minecraft 1.19.4

Changelog

Added

- fabric: Ported client-side fluid color exporter from Forge platform, see [the wiki](https://github.com/jpenilla/squaremap/wiki/Modded-Fluids-… for details

Fixed

- fabric: Crash on startup (updated library cloud from broken build)

Changelog

Added

- Forge platform (#93) - Log a warning when dirty chunks file is unusually large, with suggested config fix

Fixed

- Fix handling of invalid world url param in web GUI (now redirects to default world) - paper: Don't attempt to migrate configs for worlds named default

Changed

- Updated Russian translations #65 - Updated Chinese translations #92 - paper: Add Minecraft version and mappings checks on startup

Changelog

Changed

- Update for Minecraft 1.19.3 - Improvements to file I/O - Improved command suggestions - For example, overworld can now be suggested when world is typed (checks contains instead of starts with), and suggestions including spaces (i.e. for /squaremap help) now work properly as well

Fixed

- Compatibility with the latest Quilt loader (#83)