Skip to content

For Mod Developers

CaptainGummiball edited this page Nov 17, 2026 · 1 revision

For Mod Developers

API jar

stickynotes-api-1.jar (with stickynotes-api-1-javadoc.jar) from the releases – use it as a compile-only dependency. API version 1 contains the class dev.cptgummiball.stickynotes.api.StickyNotesApi with the mod id and the API version. There are no integration hooks yet; if you need one, open a feature request.

Do not ship the API or any Sticky Notes files in your mod. If Sticky Notes is optional for you, check that the mod stickynotes is loaded before touching its classes. The license (section 5) allows compiling against the API and publishing mods that use it.

Data formats

These formats are documented so other tools can read them; they may change with a new schema version.

Chunk data: an attachment named stickynotes:notes on each chunk (Fabric: inside fabric:attachments, NeoForge: inside neoforge:attachments):

{ schema: 1, notes: [ { id, pos, face, u, v, depth, rot, color, text, owner, owner_name, locked, rev } ] }

pos is the block the note sticks to, face its side, u/v the centre on that face (0..1), depth the distance of the surface into the block, rot the text direction of floor and ceiling notes, rev the revision.

Item components: minecraft:dyed_color holds the paper colour of every note; written notes also have stickynotes:note = {text, owner, owner_name, locked}.

Compatibility notes

  • Notes are not blocks or entities: block scanners, minimaps or protection mods do not see them.
  • Every block change through LevelChunk#setBlockState is watched (one hash lookup per change in levels with notes); mods that move blocks this way make the notes drop correctly.
  • Sticky Notes protects its own data with server checks. It honours spawn protection (mayInteract) on placement; claim mods are not integrated in 1.0.

Clone this wiki locally