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.21.tar.gz (3.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.21-cp312-cp312-manylinux_2_34_x86_64.whl (512.5 kB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

File details

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

File metadata

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

File hashes

Hashes for nucleation-0.1.21.tar.gz
Algorithm Hash digest
SHA256 b83f4b1a97f4093fbdeb8f57cb25a7964bfdef066bb40cbd8a9da6cd157fdf21
MD5 bab479e1d00acf552364eb77f9acdd38
BLAKE2b-256 4aabad6eee99e701c3dfe93086b9d1a7e8dabe6ac0fe51d1d34d97d973565749

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nucleation-0.1.21-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 8e6204fbca7d39594228b12de67f1460e2895d13a494f8cf666c09815b284f33
MD5 1528da8f45e14142244991ce9f1807fd
BLAKE2b-256 9efaaa34481e721bb8576fac2a67e442107c04eeb8b63bb6504c9ecaa3e75761

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