voxelchain-formats

A collection of tools to work with the VoxelChain file formats

Documentation:

The documentation is auto-generated and can be found here.

Installation:

Package installation:

npm install voxelchain-formats

Example:

import * as VoxelChainFormats from "voxelchain-formats";

// Load a .vxwo binary
fetch("world.vxwo").then(resp => resp.arrayBuffer()).then(buffer => {
  // Create an uint8 view into the buffer
  const binary = new Uint8Array(buffer);
  // Decompress the binary data
  const decompressed = VoxelChainFormats.decompressGZIP(binary);
  // Parse the binary data
  const parsed = VoxelChainFormats.parseVXWOFile(decompressed);
  console.log("Parsed world:", parsed);
  // Compile the parsed world back into binary
  const compiled = VoxelChainFormats.compileVXWOFile(parsed);
  // Compress the binary data
  const compressed = VoxelChainFormats.compressGZIP(binary);
  console.log("Re-compiled world:", compressed);
});

Cell Binary Layout

Cells are bitfields with the following layout:

| Offset | Length | Description |----------|---------------|----------------- | 0 | 8 | Material Id | 8 | 8 | State Data | 16 | 3 | Animation Index | 19 | 5 | Rotation Data

Flow Binary Layout

Flows are bitfields with the following layout:

| Offset | Length | Description |----------|---------------|----------------- | 0 | 4 | Power | 4 | 1 | Power Signal