nucleation 0.1.72 → 0.1.75

package/README.md

@@ -1,6 +1,6 @@
-# 🧬 Nucleation
+# 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**.
+**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.
 
@@ -12,40 +12,42 @@
 
 ---
 
-## ✨ Features
+## 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)
+- Multi-format support: `.schematic`, `.litematic`, `.nbt`, etc.
+- Memory-safe Rust core with zero-copy deserialization
+- WASM module for browser + Node.js with simulation support
+- Native Python bindings (`pip install nucleation`)
+- C-compatible FFI for PHP, C, Go, etc.
+- Redstone circuit simulation via MCHPRS integration (optional `simulation` feature)
+- Bracket notation for setting blocks with properties: `"minecraft:lever[facing=east,powered=false]"`
+- Feature parity across all interfaces
+- Binary builds for Linux, macOS, Windows (x86_64 + ARM64)
+- Seamless integration with [Cubane](https://github.com/Nano112/cubane)
 
 ---
 
-## 📦 Installation
+## Installation
 
-### 🔧 Rust
+### Rust
 
 ```bash
 cargo add nucleation
 ````
 
-### 🌐 JavaScript / TypeScript (WASM)
+### JavaScript / TypeScript (WASM)
 
 ```bash
 npm install nucleation
 ```
 
-### 🐍 Python
+### Python
 
 ```bash
 pip install nucleation
 ```
 
-### 🧩 C / PHP / FFI
+### C / PHP / FFI
 
 Download prebuilt `.so` / `.dylib` / `.dll` from [Releases](https://github.com/Schem-at/Nucleation/releases)
 or build locally using:
@@ -56,7 +58,7 @@ or build locally using:
 
 ---
 
-## 🚀 Quick Examples
+## Quick Examples
 
 ### Rust
 
@@ -69,7 +71,7 @@ schematic.load_from_data(&bytes)?;
 println!("{:?}", schematic.get_info());
 ```
 
-📖 → [More in `examples/rust.md`](examples/rust.md)
+[More in `examples/rust.md`](examples/rust.md)
 
 ---
 
@@ -85,7 +87,25 @@ await parser.fromData(new Uint8Array(bytes));
 console.log(parser.getDimensions());
 ```
 
-📖 → [More in `examples/wasm.md`](examples/wasm.md)
+**Setting blocks with properties (bracket notation):**
+
+```js
+const schematic = new SchematicWrapper();
+schematic.set_block(0, 1, 0, "minecraft:lever[facing=east,powered=false,face=floor]");
+schematic.set_block(5, 1, 0, "minecraft:redstone_wire[power=15,east=side,west=side]");
+```
+
+**Redstone simulation:**
+
+```js
+const simWorld = schematic.create_simulation_world();
+simWorld.on_use_block(0, 1, 0); // Toggle lever
+simWorld.tick(2);
+simWorld.flush();
+const isLit = simWorld.is_lit(15, 1, 0); // Check if lamp is lit
+```
+
+[More in `examples/wasm.md`](examples/wasm.md)
 
 ---
 
@@ -103,7 +123,7 @@ schem.load_from_bytes(data)
 print(schem.get_info())
 ```
 
-📖 → [More in `examples/python.md`](examples/python.md)
+[More in `examples/python.md`](examples/python.md)
 
 ---
 
@@ -122,17 +142,20 @@ printf("Size: %dx%dx%d\n", info.width, info.height, info.depth);
 schematic_free(handle);
 ```
 
-📖 → [More in `examples/ffi.md`](examples/ffi.md)
+[More in `examples/ffi.md`](examples/ffi.md)
 
 ---
 
-## 🔧 Development
+## Development
 
 ```bash
 # Build the Rust core
 cargo build --release
 
-# Build WASM module
+# Build with simulation support
+cargo build --release --features simulation
+
+# Build WASM module (includes simulation)
 ./build-wasm.sh
 
 # Build Python bindings locally
@@ -140,11 +163,19 @@ maturin develop --features python
 
 # Build FFI libs
 ./build-ffi.sh
+
+# Run tests
+cargo test
+cargo test --features simulation
+./test-wasm.sh  # WASM tests with simulation
+
+# Pre-push verification (recommended before pushing)
+./pre-push.sh  # Runs all checks that CI runs
 ```
 
 ---
 
-## 📚 Submodules & Bindings
+## Submodules & Bindings
 
 ### Rust
 * [`examples/rust.md`](examples/rust.md)
@@ -160,10 +191,9 @@ maturin develop --features python
 
 ---
 
-## ⚖️ License
+## License
 
 Licensed under the **GNU AGPL-3.0-only**.
 See [`LICENSE`](./LICENSE) for full terms.
 
-
-Made by [@Nano112](https://github.com/Nano112) with ❤️
+Made by [@Nano112](https://github.com/Nano112)