@transformosa/bcf-js
v0.1.3-patch1
Published
bcf-js is a BIM Collaboration Format (BCF) reader & parser.
Downloads
2
Maintainers
Readme
bcf-js
bcf-js is a BIM Collaboration Format (BCF) reader & parser. bcf-js is ready for BCF 2.1
Find it on npmjs.com https://www.npmjs.com/package/@parametricos/bcf-js
Note: This software is experimental (WIP)
Getting Started
To install the library use:
npm install @parametricos/bcf-js
or yarn add @parametricos/bcf-js
Contribution
There's a few ways to contribute to this project and improve it:
- Fork the project repository and make your first pull request
- Submit sample BCF and it's linked IFC files in the 'test-data' folder
- Test it and create Issues so that we can start working on them
Please feel free to contact us about contributing at [email protected] or send us a message on Linkedin, Twitter & Instagram
Join our Community
Ask us to invite you to our Slack Channels or join our newly created community on Discord
Using the library
import { BcfReader } from '@parametricos/bcf-js';
...
const file = "some_bcf_file.bcf"
const reader = new BcfReader();
await reader.read(file);
reader.topics.forEach((topic) => {
console.log(topic);
})
Developed
BCF-js is developed and maintained by Parametricos Ltd. for Studio 3DX and was open sourced on the 26th of May 2021 in the name of BIM and it's community!
License
BCF-js is licensed under the Mozilla Public License 2.0. Please read the LICENSE file in this repository for more details.