Skip to main content

A high-performance Minecraft schematic parser and utility library

Project description

🧬 Nucleation

Nucleation is a high-performance Minecraft schematic engine written in Rust — with full support for Rust, WebAssembly/JavaScript, Python, and FFI-based integrations like PHP and C.

Built for performance, portability, and parity across ecosystems.


Crates.io npm PyPI


✨ Features

  • ✅ Multi-format support: .schematic, .litematic, .nbt, etc.
  • 🧠 Memory-safe Rust core with zero-copy deserialization
  • 🌐 WASM module for browser + Node.js
  • 🐍 Native Python bindings (pip install nucleation)
  • ⚙️ C-compatible FFI for PHP, C, Go, etc.
  • 🔄 Feature parity across all interfaces
  • 📦 Binary builds for Linux, macOS, Windows (x86_64 + ARM64)
  • 🧱 Seamless integration with Cubane

📦 Installation

🔧 Rust

cargo add nucleation

🌐 JavaScript / TypeScript (WASM)

npm install nucleation

🐍 Python

pip install nucleation

🧩 C / PHP / FFI

Download prebuilt .so / .dylib / .dll from Releases or build locally using:

./build-ffi.sh

🚀 Quick Examples

Rust

use nucleation::UniversalSchematic;

let bytes = std::fs::read("example.litematic")?;
let mut schematic = UniversalSchematic::new("my_schematic");
schematic.load_from_data(&bytes)?;
println!("{:?}", schematic.get_info());

📖 → More in examples/rust.md


JavaScript (WASM)

import { SchematicParser } from "nucleation";

const bytes = await fetch("example.litematic").then(r => r.arrayBuffer());
const parser = new SchematicParser();
await parser.fromData(new Uint8Array(bytes));

console.log(parser.getDimensions());

📖 → More in examples/wasm.md


Python

from nucleation import Schematic

with open("example.litematic", "rb") as f:
    data = f.read()

schem = Schematic("my_schematic")
schem.load_from_bytes(data)

print(schem.get_info())

📖 → More in examples/python.md


FFI (PHP/C)

#include "nucleation.h"

SchematicHandle* handle = schematic_new("MySchem");
schematic_load_data(handle, data_ptr, data_len);

CSchematicInfo info;
schematic_get_info(handle, &info);
printf("Size: %dx%dx%d\n", info.width, info.height, info.depth);

schematic_free(handle);

📖 → More in examples/ffi.md


🔧 Development

# Build the Rust core
cargo build --release

# Build WASM module
./build-wasm.sh

# Build Python bindings locally
maturin develop --features python

# Build FFI libs
./build-ffi.sh

📚 Submodules & Bindings

Rust

JavaScript/TypeScript

Python

FFI (C/PHP)


⚖️ License

Licensed under the GNU AGPL-3.0-only. See LICENSE for full terms.

Made by @Nano112 with ❤️

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nucleation-0.1.32.tar.gz (5.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nucleation-0.1.32-cp312-cp312-manylinux_2_34_x86_64.whl (517.0 kB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

File details

Details for the file nucleation-0.1.32.tar.gz.

File metadata

  • Download URL: nucleation-0.1.32.tar.gz
  • Upload date:
  • Size: 5.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.8.7

File hashes

Hashes for nucleation-0.1.32.tar.gz
Algorithm Hash digest
SHA256 08691e8845fcee6b01c9028c1fd2dfc8aa62b428ff17f5af11b506d3ee39d126
MD5 d9439183545d1b25dec926f7c89eca33
BLAKE2b-256 e602e34366e55cff2df45f6397e4172d20924e93c8ace4c8b1b38e91c6d43a66

See more details on using hashes here.

File details

Details for the file nucleation-0.1.32-cp312-cp312-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for nucleation-0.1.32-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 03b6adff24c4047e23fe6c595787a5e236e6c54005c3b83aa51d2edf1e203013
MD5 e3f437684ae233a9941aa851f321c5d9
BLAKE2b-256 b742adb4b860189901d280b510ba7067f891c241b7cbf1ef8862e84f1c1a068e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page