Wiki 9Minecraft Wiki 9Minecraft

ChunkAPI Mod Wiki & Guide

Java EditionModGuides 4FAQ 10Related mods 48

Provides an API for chunk manipulation and management.

DownloadChunkAPI Mod

Get the files on 9Minecraft

Contents (4)
  1. Guides
  2. Frequently asked questions
  3. Gallery
  4. You May Also Like

Guides

Step-by-step, in-game.

Persist Custom Data Across World ReloadsHow Persistence Works ChunkAPI Mod saves all custom chunk data to NBT (Named Binary Tag) format, the same system…Register a Custom Data HandlerUnderstanding Data Handlers A data handler is how mods tell ChunkAPI what custom information to manage. Handlers…Store Custom Data in Your ChunksUnderstanding Chunk Data Storage ChunkAPI Mod allows you to attach custom data to chunks without modifying…Sync Custom Chunk Data Between Server and ClientNetwork Synchronization Overview ChunkAPI Mod automatically handles synchronization of custom chunk data whenever…

Frequently asked questions

How do I start using ChunkAPI in my mod?
First, register your data handler using the centralized registry provided by ChunkAPI. Then, implement the data storage and syncing logic for your chunks using the mod's API methods. The guides on registering custom data handlers and storing custom chunk data will walk you through the setup.
What's the difference between chunk-level and section-level data?
Chunk-level data applies to the entire chunk, while section-level data is stored per block section (16×16×16 vertical slices). Use section-level NBT handling when you need to track data at finer vertical granularity, such as per-layer properties.
Do I need to manually edit base game files to use ChunkAPI?
No—that's the whole point of ChunkAPI. The mod handles all chunk data storage and networking without modifying base game classes, keeping your setup clean and compatible with other mods.
How does ChunkAPI sync data between server and client?
ChunkAPI intercepts and modifies vanilla chunk network packets (like S21PacketChunkData) to carry your custom data alongside the standard chunk information. This happens automatically once you register your data handler, so both sides stay in sync without extra work.

See all 10 ChunkAPI questions ›