# 🧬 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.
---
[](https://crates.io/crates/nucleation)
[](https://www.npmjs.com/package/nucleation)
[](https://pypi.org/project/nucleation)
---
## ✨ 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](https://github.com/Nano112/cubane)
---
## 📦 Installation
### 🔧 Rust
```bash
cargo add nucleation
````
### 🌐 JavaScript / TypeScript (WASM)
```bash
npm install nucleation
```
### 🐍 Python
```bash
pip install nucleation
```
### 🧩 C / PHP / FFI
Download prebuilt `.so` / `.dylib` / `.dll` from [Releases](https://github.com/Schem-at/Nucleation/releases)
or build locally using:
```bash
./build-ffi.sh
```
---
## 🚀 Quick Examples
### Rust
```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`](examples/rust.md)
---
### JavaScript (WASM)
```ts
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`](examples/wasm.md)
---
### Python
```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`](examples/python.md)
---
### FFI (PHP/C)
```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`](examples/ffi.md)
---
## 🔧 Development
```bash
# 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
* [`examples/rust.md`](examples/rust.md)
### JavaScript/TypeScript
* [`examples/wasm.md`](examples/wasm.md)
### Python
* [`examples/python.md`](examples/python.md)
### FFI (C/PHP)
* [`examples/ffi.md`](examples/ffi.md)
---
## ⚖️ License
Licensed under the **GNU AGPL-3.0-only**.
See [`LICENSE`](./LICENSE) for full terms.
Made by [@Nano112](https://github.com/Nano112) with ❤️
Raw data
{
"_id": null,
"home_page": null,
"name": "nucleation",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "minecraft, schematic, parser, voxel",
"author": "Nano nano@schem.at",
"author_email": "Nano <nano@schem.at>",
"download_url": "https://files.pythonhosted.org/packages/21/0b/ee873513e70f2331dc49975f1b20b8d21e0e1b150ee5d6411d5945068148/nucleation-0.1.69.tar.gz",
"platform": null,
"description": "# \ud83e\uddec Nucleation\n\n**Nucleation** is a high-performance Minecraft schematic engine written in Rust \u2014 with full support for **Rust**, **WebAssembly/JavaScript**, **Python**, and **FFI-based integrations** like **PHP** and **C**.\n\n> Built for performance, portability, and parity across ecosystems.\n\n---\n\n[](https://crates.io/crates/nucleation)\n[](https://www.npmjs.com/package/nucleation)\n[](https://pypi.org/project/nucleation)\n\n---\n\n## \u2728 Features\n\n- \u2705 Multi-format support: `.schematic`, `.litematic`, `.nbt`, etc.\n- \ud83e\udde0 Memory-safe Rust core with zero-copy deserialization\n- \ud83c\udf10 WASM module for browser + Node.js\n- \ud83d\udc0d Native Python bindings (`pip install nucleation`)\n- \u2699\ufe0f C-compatible FFI for PHP, C, Go, etc.\n- \ud83d\udd04 Feature parity across all interfaces\n- \ud83d\udce6 Binary builds for Linux, macOS, Windows (x86_64 + ARM64)\n- \ud83e\uddf1 Seamless integration with [Cubane](https://github.com/Nano112/cubane)\n\n---\n\n## \ud83d\udce6 Installation\n\n### \ud83d\udd27 Rust\n\n```bash\ncargo add nucleation\n````\n\n### \ud83c\udf10 JavaScript / TypeScript (WASM)\n\n```bash\nnpm install nucleation\n```\n\n### \ud83d\udc0d Python\n\n```bash\npip install nucleation\n```\n\n### \ud83e\udde9 C / PHP / FFI\n\nDownload prebuilt `.so` / `.dylib` / `.dll` from [Releases](https://github.com/Schem-at/Nucleation/releases)\nor build locally using:\n\n```bash\n./build-ffi.sh\n```\n\n---\n\n## \ud83d\ude80 Quick Examples\n\n### Rust\n\n```rust\nuse nucleation::UniversalSchematic;\n\nlet bytes = std::fs::read(\"example.litematic\")?;\nlet mut schematic = UniversalSchematic::new(\"my_schematic\");\nschematic.load_from_data(&bytes)?;\nprintln!(\"{:?}\", schematic.get_info());\n```\n\n\ud83d\udcd6 \u2192 [More in `examples/rust.md`](examples/rust.md)\n\n---\n\n### JavaScript (WASM)\n\n```ts\nimport { SchematicParser } from \"nucleation\";\n\nconst bytes = await fetch(\"example.litematic\").then(r => r.arrayBuffer());\nconst parser = new SchematicParser();\nawait parser.fromData(new Uint8Array(bytes));\n\nconsole.log(parser.getDimensions());\n```\n\n\ud83d\udcd6 \u2192 [More in `examples/wasm.md`](examples/wasm.md)\n\n---\n\n### Python\n\n```python\nfrom nucleation import Schematic\n\nwith open(\"example.litematic\", \"rb\") as f:\n data = f.read()\n\nschem = Schematic(\"my_schematic\")\nschem.load_from_bytes(data)\n\nprint(schem.get_info())\n```\n\n\ud83d\udcd6 \u2192 [More in `examples/python.md`](examples/python.md)\n\n---\n\n### FFI (PHP/C)\n\n```c\n#include \"nucleation.h\"\n\nSchematicHandle* handle = schematic_new(\"MySchem\");\nschematic_load_data(handle, data_ptr, data_len);\n\nCSchematicInfo info;\nschematic_get_info(handle, &info);\nprintf(\"Size: %dx%dx%d\\n\", info.width, info.height, info.depth);\n\nschematic_free(handle);\n```\n\n\ud83d\udcd6 \u2192 [More in `examples/ffi.md`](examples/ffi.md)\n\n---\n\n## \ud83d\udd27 Development\n\n```bash\n# Build the Rust core\ncargo build --release\n\n# Build WASM module\n./build-wasm.sh\n\n# Build Python bindings locally\nmaturin develop --features python\n\n# Build FFI libs\n./build-ffi.sh\n```\n\n---\n\n## \ud83d\udcda Submodules & Bindings\n\n### Rust\n* [`examples/rust.md`](examples/rust.md)\n\n### JavaScript/TypeScript\n* [`examples/wasm.md`](examples/wasm.md)\n\n### Python\n* [`examples/python.md`](examples/python.md)\n\n### FFI (C/PHP)\n* [`examples/ffi.md`](examples/ffi.md)\n\n---\n\n## \u2696\ufe0f License\n\nLicensed under the **GNU AGPL-3.0-only**.\nSee [`LICENSE`](./LICENSE) for full terms.\n\n\nMade by [@Nano112](https://github.com/Nano112) with \u2764\ufe0f\n",
"bugtrack_url": null,
"license": "AGPL-3.0-only",
"summary": "A high-performance Minecraft schematic parser and utility library",
"version": "0.1.69",
"project_urls": {
"Source Code": "https://github.com/Schem-at/Nucleation"
},
"split_keywords": [
"minecraft",
" schematic",
" parser",
" voxel"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2c7ab4b83afc9bc2385562606ab736c0f5d54418597b6fc7eaf0d35434a8224a",
"md5": "ab19178adf1071389e5884c8c1327fbd",
"sha256": "41ec340c33c26d9ac94ba904b5f3721efb6b5b42c727227c3527e55e18efe248"
},
"downloads": -1,
"filename": "nucleation-0.1.69-cp312-cp312-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "ab19178adf1071389e5884c8c1327fbd",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.8",
"size": 519203,
"upload_time": "2025-07-10T05:32:52",
"upload_time_iso_8601": "2025-07-10T05:32:52.579350Z",
"url": "https://files.pythonhosted.org/packages/2c/7a/b4b83afc9bc2385562606ab736c0f5d54418597b6fc7eaf0d35434a8224a/nucleation-0.1.69-cp312-cp312-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "210bee873513e70f2331dc49975f1b20b8d21e0e1b150ee5d6411d5945068148",
"md5": "0318ce338fcacd630d1427c7e0b3c8d2",
"sha256": "dae4dfd3db9c61f5ccacbd44e187cd014d7825dbee2d72956b464eca10d1f421"
},
"downloads": -1,
"filename": "nucleation-0.1.69.tar.gz",
"has_sig": false,
"md5_digest": "0318ce338fcacd630d1427c7e0b3c8d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6185359,
"upload_time": "2025-07-10T05:32:54",
"upload_time_iso_8601": "2025-07-10T05:32:54.621428Z",
"url": "https://files.pythonhosted.org/packages/21/0b/ee873513e70f2331dc49975f1b20b8d21e0e1b150ee5d6411d5945068148/nucleation-0.1.69.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 05:32:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Schem-at",
"github_project": "Nucleation",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nucleation"
}
JSON
