@mcflamingo/bmf-node
v0.2.1
Published
Rust core bindings for BMF — URDF/MJCF parse + kin.* capability derivation (napi-rs). Source of truth for robotics kinds; do not reimplement in TypeScript.
Maintainers
Readme
@mcflamingo/bmf-node
Rust is the source of truth for BMF robotics kinds (urdf, mjcf). This package is the napi-rs binding over bmf-core — URDF/MJCF parse + kin.* / safety.workspace.limits derivation.
Do not reimplement these parsers in TypeScript. The TypeScript SDK (@mcflamingo/bmf-sdk) calls into this addon.
API
const { parseUrdf, parseMjcf } = require("@mcflamingo/bmf-node");
const { robot, capabilities } = JSON.parse(parseUrdf(urdfXml));
// capabilities: [{ name: "kin.urdf" }, { name: "kin.arm" }, { name: "kin.dof.arm", attrs: { dof: "6" } }, ...]Build
Requires Rust stable (≥ 1.88).
cd core-rs/bmf-node
npm run build # cargo build -p bmf-node --release → bmf_node.node
npm testLicense
Apache-2.0.
