\r\n\r\n[](https://github.com/tomvandig/web-ifc/actions/workflows/build.yml)\r\n\r\n\r\n\r\n**web-ifc** is a javascript library to read and write ifc files, at native speeds. **web-ifc** is part of the [ifc.js](https://ifcjs.github.io/info/) project, which aims to lower the threshold for developing open BIM applications.\r\n\r\n## Status\r\n\r\nAlthough it is quite stable and fast already, web-ifc is in **pre-alpha status** until ifc support matures. The list of currently supported ifc elements, or level of support for different ifc types, is an undocumented work in progress. \r\n\r\nDepending on your models, web-ifc may be quick and correct, or slow and broken. If your model does not work as expected please raise an issue and attach the model if possible, or contact us and we can discuss passing the model confidentially.\r\n\r\n## Install\r\n\r\n`npm install web-ifc`\r\n\r\n## Quick setup\r\n\r\n```JavaScript\r\nconst WebIFC = require(\"web-ifc/web-ifc-api.js\");\r\n\r\n// initialize the API\r\nconst ifcApi = new WebIFC.IfcAPI();\r\n\r\n// initialize the library\r\nawait ifcApi.Init();\r\n\r\n// open a model from data\r\nlet modelID = ifcApi.OpenModel(/* IFC data as a string or UInt8Array */, /* optional settings object */, );\r\n\r\n// the model is now loaded! use modelID to fetch geometry or properties\r\n// checkout examples/usage for some details on how to read/write IFC\r\n\r\n// close the model, all memory is freed\r\nifcApi.CloseModel(modelID);\r\n\r\n```\r\n\r\nSee [examples](https://github.com/tomvandig/web-ifc/tree/main/examples/usage/src) for more details on how to use web-ifc.\r\n\r\n## Current Build\r\n\r\nThe current live build of web-ifc is avaialble [here](https://ifcjs.github.io/web-ifc/build.zip). Using this allows you to test newest fixes before we make a release. If you wish to use this version then download the zip file and place the contents of the dist folder manually into your node_modules/web-ifc folder. I.e if you are using web-ifc-three then it will be node_modules/web-ifc-three/node_modules/web-ifc. Please not you must replace the javascript and the WASM.\r\n\r\n## Requirements\r\n\r\nThese are the requirements needed to build web-ifc (only for those that wish to build their own version).\r\n\r\n1. Node v16 or later\r\n2. NPM v7 or later\r\n3. EMSCRIPTEN v3.1.44 or later\r\n4. CMAKE v3.18 or later\r\n\r\n## Building WASM module\r\n\r\n### Setting up emscripten and build system\r\n\r\nThe WASM library is built through emscripten, please see [the emscripten installation guide](https://emscripten.org/docs/getting_started/downloads.html) for information on how to set up emscripten. Afterwards `emsdk_env` needs to be in your path.\r\n\r\nTo build the WASM you also need CMAKE [see here](https://cmake.org/download/) and (on windows) MINGW [see here](https://sourceforge.net/projects/mingw/) - once installed (and in your path) run `npm run setup-mingw` to configure the environment for web-ifc.\r\n\r\n### WASM library\r\n\r\nRun `npm install` to install all dependencies.\r\n\r\nRun `npm run setup-env` whenever you open a new terminal, this will set up the required emscripten environment variables for you to compile code.\r\n\r\nRun `npm run build-release` to build a release version of the wasm binary and the accompanying web-ifc api. It will be placed in `./dist`.\r\n\r\nIf you wish to build the WASM with debugging enabled you can run `npm run build-debug`. This will enable you to inspect debugging information better when running web-ifc.\r\n\r\nRun `npm run dev` to launch a development server with a basic ifc file viewer.\r\n\r\n## Stand alone C++\r\n\r\nAlthough the primary focus of the library is to be used through WebAssembly in the browser/nodejs, the project can be used stand-alone as a c++ library or executable. See [here](https://github.com/tomvandig/web-ifc/blob/main/src/wasm/web-ifc-test.cpp) for a simple entry point to get started.\r\n\r\n## Contributing\r\n\r\nWant to help out? Great!\r\n\r\nPlease checkout [our contribution suggestsions](https://github.com/tomvandig/web-ifc/blob/main/contributing.md).\r\n","readmeFilename":"README.md"}
![](\"https://ifcjs.github.io/info/img/logo.svg\"){kind=logo}
![](\"banner.png\")
\r\n