nucleation
A high-performance Minecraft schematic engine, powered by a native Rust core. Parse, edit, diff, fingerprint, and generate schematics from Python.
Policy-driven normalization, material profiles, content inspection, UUID standardization, bounded decoding, and registry routing are documented in the complete transformation-policy guide.
Wheels are published for CPython 3.12+ (stable ABI) on Linux, macOS, and Windows.
They include a py.typed marker and generated .pyi stubs for Mypy, Pyright,
and editor completion. The installed package-level __init__.pyi explicitly
re-exports every generated native type, followed by the hand-written veneer
types; this keeps package exports equally visible to Mypy and Pyright while
preserving the native classes' type identities.
Install
pip install nucleation
Quick start
import nucleation
schematic = nucleation.Schematic.create("demo")
schematic.set_block(1, 2, 3, "minecraft:stone")
print(schematic.get_block_name(1, 2, 3)) # "minecraft:stone"
schematic.save_to_file("demo.litematic")
loaded = nucleation.Schematic.load_from_file("demo.litematic")
Normalize imported content
Preview and apply the same versioned policy contract used by every language binding:
from nucleation import Schematic, TransformPlan, inspect_transform, apply_transform
schematic = Schematic.open("incoming.schem")
plan = TransformPlan.registry_safe()
preview = inspect_transform(schematic, plan)
if not preview.rejected and not preview.quarantined:
report = apply_transform(schematic, plan)
schematic.save("normalized.schem")
Inspection never mutates the schematic. Apply is atomic: a rejecting rule
returns report.rejected == True and leaves the original unchanged. For only
lossless palette cleanup, use TransformPlan.canonical().
Split disconnected builds
Keep every meaningful connected machine independent while attaching only tiny, nearby loose parts:
schematic = nucleation.Schematic.open("combined.schem")
pieces = schematic.split_connected_attach_nearby(
16, # components this large always remain standalone
3, # tiny parts may attach across at most three empty blocks
)
for index in range(pieces.len()):
pieces.piece(index).save(f"machine-{index + 1}.schem")
Attachment is lossless and non-transitive: fragments cannot form a chain that recombines otherwise independent builds. Whole-world extraction, including the Python control plane and remote Store worker, is documented in the world-segmentation guide.
To emit every disconnected component literally, use a zero standalone threshold. Every component then becomes a core and the gap is ignored:
pieces = schematic.split_connected_attach_nearby(0, 0)
Curate a lossless corpus
Keep raw extraction lossless, then build registry and ranking views with an auditable policy. Every rejected ID and reason is retained:
from pathlib import Path
from nucleation import (
CurationPolicy,
curate_corpus,
write_registry_archives,
write_top_owner_archives,
)
policy = CurationPolicy.minima(
min_blocks=2, # reject standalone blocks
min_palette_names=2, # reject one-material schematics
name="ore-sanity-v1",
)
corpus = curate_corpus(Path("/data/ore"), Path("/data/ore/curation/ore-sanity-v1"), policy)
write_registry_archives(corpus, Path("/data/ore/registry-import"))
write_top_owner_archives(corpus, Path("/data/ore/top-20-owner-archives"))
CurationPolicy also accepts declarative MetricRule entries over analyser or
catalogue fields and named Python predicates. The policy receives a stable
SHA-256 content ID which is embedded into package indexes and owner manifests.
Changing a filter therefore cannot silently reuse an older curated result.
What is included
The published wheel contains the core feature set: schematic editing, all schematic formats, world import and export (including streaming), the schematic builder, the procedural building tool, definition regions, diff and fingerprinting, autostack, NBT helpers, SDF sampling, and the in-memory/filesystem store.
Redstone simulation, mesh generation, GPU rendering, and embedded scripting require building the package from source with the extra cargo features enabled (a Rust toolchain is required):
git clone https://github.com/Schem-at/Nucleation
cd Nucleation
pip install ./bindings/python
The source build defaults to the full feature set (bridge-full). Set the
NUCLEATION_FEATURES environment variable to choose a different cargo feature list,
for example NUCLEATION_FEATURES=bridge,simulation.
Documentation
License
MIT
Building a smaller feature set
Published wheels include bridge-full. A source build can select a smaller
Cargo feature set, including transitive dependencies:
NUCLEATION_FEATURES=bridge pip install --no-binary=nucleation nucleation
NUCLEATION_FEATURES=bridge,rendering,mc-tick pip install --no-binary=nucleation nucleation
bridge is required. Cargo's normal default features stay enabled. Disabled
features omit their Python types and methods, including animation rendering
methods. Enable scripting-lua or scripting-js explicitly when needed; a
minimal build requires neither scripting engine. Selection reads the same
Cargo feature definitions and Rust bridge gates for checkouts and sdists.
On Android/Termux, the build explicitly links the interpreter library and
android/log. Install matching Python development libraries; a missing
interpreter library fails configuration. Ordinary Linux/macOS extensions keep
nanobind's module linkage, without imposing a new libpython dependency.
Native errors
Catch nucleation.NucleationError for engine failures and inspect error.code
against nucleation.NucleationErrorCode constants. This also applies to
nucleation.core and the open/save convenience methods. Python argument
errors are not converted into engine errors.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nucleation-0.10.24.tar.gz.
File metadata
- Download URL: nucleation-0.10.24.tar.gz
- Upload date:
- Size: 2.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a04a349d46d46eed3c289c6b0f1328b21ae2a1c2f77e925531ca4a57ccca65a1
|
|
| MD5 |
f4285423a80d08f69aa88c7863eaf7c5
|
|
| BLAKE2b-256 |
118e96fc0ef85b6708d25f97922592872882e835b81ccf30e944cf926b67b263
|
File details
Details for the file nucleation-0.10.24-cp312-abi3-win_amd64.whl.
File metadata
- Download URL: nucleation-0.10.24-cp312-abi3-win_amd64.whl
- Upload date:
- Size: 12.0 MB
- Tags: CPython 3.12+, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc2c09c815a776772ed8a4cddb689c585546afa9bb9c29df5e7aab998edd94ed
|
|
| MD5 |
f834350299ad95c922e78f74ecec0e84
|
|
| BLAKE2b-256 |
14e1e9bddbe31b6f6a9af416e5049cbca1bcf13a0bcd8843a45b57c21c12650d
|
File details
Details for the file nucleation-0.10.24-cp312-abi3-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: nucleation-0.10.24-cp312-abi3-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 17.2 MB
- Tags: CPython 3.12+, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b5dc1699265601545fd36fcdd9235891196c6498b4bc34004193e67fac76e648
|
|
| MD5 |
018436cb40c6c949aa81121877d8fba2
|
|
| BLAKE2b-256 |
a54ccaef7d02144e087c417c929fc0f23093a65b60524dfe9ae0c87f974534fb
|
File details
Details for the file nucleation-0.10.24-cp312-abi3-macosx_11_0_arm64.whl.
File metadata
- Download URL: nucleation-0.10.24-cp312-abi3-macosx_11_0_arm64.whl
- Upload date:
- Size: 14.2 MB
- Tags: CPython 3.12+, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a2b9df5466ecab23748ba06683bd726a370e38c82b552e08c30754b715d71241
|
|
| MD5 |
364a1cc4f0cb74bdff04e31a6ea10051
|
|
| BLAKE2b-256 |
0552bfc44b00f75d7a42db70e83e898f2d077073a521c97f79755e347c1cabe4
|
