ladybug-tools / spider-core

Lightweight JavaScript modules containing the core data parsing and rendering functions of Spider.
http://www.ladybug.tools/spider-core/docs/latest/
MIT License
3 stars 3 forks source link
3d javascript node

NPM

Build Status npm Download npm installs GitHub license

Spider

Spider-Core

Lightweight JavaScript modules containing the core data parsing and rendering functions of Spider.

Installation

npm install --save @ladybug-tools/spider-core

QuickStart

The spider-core package aims to provide a data manipulation layer from which users can build 3D visualisation tools as well as general 3D model debugging applications.

const fs = require('fs');
const Spider = require('@ladybug-tools/spider-core');

const gbXMLString = fs.readFileSync('/path/to/file.gbxml').toString();

const gbXMLJson = Spider.gbXMLParser.parseFileXML(gbXMLString);

console.log(JSON.stringify(gbXMLJson, null, 2));

Documentation

Full API documentation of the latest version of this package can be found here.

Contributing

Contributions are most welcome! Please refere to the contributing guide to help you get started.

Releases

A list of releases and changes applied for each one can be found here.