@jscad/io

@jscad/io

Input/Output format handling for the JSCAD project.

Overview

This package is a metapackage and includes all the input/output format handling for the JSCAD projects, and can also be used separately.

Inputs / Deserializers

ie: file data => JSCAD code or JSCAD geometry

Following formats are supported as inputs

• AMF
• DXF
• JSON
• OBJ
• STL (binary, ASCII)
• SVG
• X3D

Outputs/ Serializers

ie: geometry => blob

Following formats are supported as outputs

• AMF
• DXF
• JSON
• OBJ
• STL (binary, ASCII)
• SVG
• X3D
• 3MF

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

npm install @jscad/io

Usage

• As a Node module :

const io = require('@jscad/io')

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 GitHub.

• 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)