Reference API surface and stability

API surface and stability

Which packages are public, what stability each carries, and which types are annotated @ApiStatus.Experimental.

This page is a generation target, currently written by hand. Source of truth: the @ApiStatus annotations on the public types of the Falco repository. The per-type list below is what a generator would replace first.

Per package

Package	Module	Stability	Binary-compatibility baseline
net.onelitefeather.falco.anvil	falco-anvil	experimental — all 24 public types annotated	checked against the last release
net.onelitefeather.falco.light	falco-light	experimental — all public types annotated	checked against the last release
net.onelitefeather.falco.instance	falco-instance	see the module Javadoc	checked against the last release
net.onelitefeather.falco.migration	falco-migration	experimental — all public types annotated	excluded — not yet released

Experimental means: signatures, class layout and behaviour may change in a minor release. Do not rely on these types in code you cannot adapt.

ChunkMigrationMode and ChunkMigrator live in net.onelitefeather.falco.anvil but belong to the migration feature, and carry the same experimental annotation.

net.onelitefeather.falco.anvil — the annotated types

FalcoAnvilLoader, RegionFile, RegionConstants, ChunkCompression, BitPacker, PaletteData, PaletteEntryResolver, BlockPaletteResolver, BiomePaletteResolver, NbtReads, SectionCodec, AnvilDiagnostics, AnvilChunkException, AnvilFault, AnvilFormatException, ChunkDataException, ChunkLocation, RegionFormatException, ChunkVersionPolicy, DefaultChunkVersionPolicy, UnknownEntryPolicy, DefaultUnknownEntryPolicy, ChunkMigrationMode and ChunkMigrator. (The package-private SectorAllocator and ServiceResolution carry no annotation and are not among the twenty-four.)

Opt-in only

Nothing switches to a Falco type by itself. A server keeps using whatever loader, light path and instance it uses today until it constructs the Falco equivalent explicitly. A migration engine on the classpath migrates nothing until a caller selects a ChunkMigrationMode.

Related: Reference Modules and coordinates · Reference Supported versions · Build Setup for what checkApiCompatibility does