@jscad/stl-deserializer

STL Deserializer for JSCAD

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
1,717112Jun 20, 2021Mar 10, 2013Minified + gzip package size for @jscad/stl-deserializer in KB

Readme

@jscad/stl-deserializer

Deserializer of STL data to JSCAD scripts or geometries

NPM version NPM downloads Build Status Stability License

User Group Lerna JavaScript Style Guide

Backers Sponsors

Open Collective

Overview

This deserializer converts raw STL formatted data (files) to JSCAD scripts or geometries.

Table of Contents

Installation

npm install @jscad/stl-deserializer

Usage

const stlDeserializer = require('@jscad/stl-deserializer')

const rawData = fs.readFileSync('PATH/TO/file.stl')
const geometry = stlDeserializer.deserialize(rawData, 'file.stl', {output: 'geometry'})

Contributing

The various JSCAD packages and all source code are part of the JSCAD Organization, and maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.

  • If you want to submit a bug report please make sure to follow the Reporting Issues guide. Bug reports are accepted as Issues via GitHub.

  • If you want to submit a change or a patch, please read the Contributing Guide. New contributions are accepted as Pull Requests via GithHub.

  • We only accept bug reports and pull requests on GitHub.

  • If you have a question about how to use JSCAD, then please start a conversation at the JSCAD User Group. You might find the answer in the JSCAD User Guide.

  • If you have a change or new feature in mind, please start a conversation with the Core Developers and start contributing changes.

Small Note: If editing this README, please conform to the standard-readme specification.

License

The MIT License (MIT) (unless specified otherwise)

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.