Skip to content

DDZMC/NeoStructureMapper

Repository files navigation

Neo Structure Mapper

Neo Structure Mapper is a NeoForge mod for Minecraft 1.21.1 that lets players capture structure regions, annotate individual blocks, and export the resulting diagrams for sharing or documentation.

Features

  • Main selections and sub-selections created in-world with the Selection Wand.
  • Structure Diagram blocks and Portable Diagrams for viewing saved selections.
  • Interactive 3D diagram GUI with rotate, pan, zoom, layer peeling, and layered blueprint mode.
  • Per-block rich-text notes, colored text, bold and italic styling, graffiti drawing, erasing, and clear-graffiti confirmation.
  • Hover previews for notes and captured block inventories.
  • ESS export/import for portable structure data.
  • Client-side PNG export with 3D model rendering, callout boxes, rich notes, graffiti, inventory contents, exporter info, and configurable annotation visibility.
  • Internal face culling for dense structures.
  • Local world storage and portable item storage.

Requirements

  • Minecraft 1.21.1
  • NeoForge 21.1.211 or compatible 21.1.x
  • Java 21

Build

Use the Gradle wrapper:

.\gradlew.bat build

To also copy the built mod jar to the project root for local testing:

.\gradlew.bat build releaseJar

The root-level release jar is intentionally ignored by git.

Configuration

Configuration is registered as a common NeoForge config under the diagram section. Notable options include:

  • notePreviewCharacters: maximum note characters shown in hover previews.
  • contentPreviewItems: maximum inventory item types shown in hover previews.
  • pngContentItems: maximum inventory item types shown in PNG annotation boxes.
  • showPngBlockContents: whether PNG annotation boxes include captured inventory contents.
  • showPngAnnotations: whether PNG exports draw annotation boxes and callout lines.
  • pngMode: PNG render mode, one of OPAQUE, NOTED, or ONION.
  • pngViewMode: fixed isometric or current GUI camera.
  • peeledLayerTransparency: alpha for peeled or transparent layers.
  • layerModeGap and layerModeFocusShift: layered blueprint spacing controls.

Controls

  • Left-drag the main model to rotate.
  • Middle-drag the main model to pan.
  • Mouse wheel over the model to zoom.
  • - and = peel layers or focus Y layers in layered blueprint mode.
  • Right-click a block in the diagram to open its note panel.
  • Esc closes the active note panel first.

Exported Files

ESS and PNG exports are written to the Minecraft game directory under expstrsch/.

License

MIT. See LICENSE for details.

About

NeoForge 1.21.1 structure selection and annotation toolkit

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages