https://github.com/mitmadness/chuck-ifc

:house: Chuck plugin that converts Industry Foundation Classes 3D models with IfcOpenShell
https://github.com/mitmadness/chuck-ifc

assetbundle build-automation ifc unity3d webservice

Last synced: about 2 months ago
JSON representation

:house: Chuck plugin that converts Industry Foundation Classes 3D models with IfcOpenShell

• Host: GitHub
• URL: https://github.com/mitmadness/chuck-ifc
• Owner: mitmadness
• License: mit
• Created: 2017-05-10T19:37:02.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-25T14:43:11.000Z (about 9 years ago)
• Last Synced: 2025-03-08T09:39:36.121Z (over 1 year ago)
• Topics: assetbundle, build-automation, ifc, unity3d, webservice
• Language: TypeScript
• Homepage:
• Size: 87.9 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# chuck-ifc [![npm version](https://img.shields.io/npm/v/@mitm/chuck-ifc.svg?style=flat-square)](https://www.npmjs.com/package/@mitm/chuck-ifc) ![license](https://img.shields.io/github/license/mitmadness/chuck-ifc.svg?style=flat-square) [![Travis Build](https://img.shields.io/travis/mitmadness/chuck-ifc.svg?style=flat-square)](https://travis-ci.org/mitmadness/chuck-ifc)

[Chuck](https://github.com/mitmadness/chuck) plugin that converts Industry Foundation Classes models with [IfcOpenShell](http://ifcopenshell.org/).

*:point_right: [@mitm/chuck](https://github.com/mitmadness/chuck), a fully-featured webservice that builds Unity3D asset bundles.*

## :white_check_mark: Requirements

The plugin requires you to install [IfcConvert](http://ifcopenshell.org/ifcconvert.html) globally (at least, it must be available it the `$PATH`).

Ensure that the version you download is superior or equal to version 0.5. The library is known to crash on 0.4 and prior versions.

## :package: Installation & Usage

Like any other chuck plugin, install it alongside of `@mitm/chuck`:

```

yarn add @mitm/chuck-ifc

```

Then load it with chuck (see chuck's documentation about configuration and plugins if necessary):

```

CHUCK_STEPMODULEPLUGINS=@mitm/chuck-ifc yarn chuck

```

## :wrench: Configuration

Like with chuck, configuration is done via environment variables.

| Variable                   | Default                        | Description |

|----------------------------|--------------------------------|-------------|

| `CHUCK_IFC_IFCCONVERTPATH` | `IfcConvert` (= in the `PATH`) | Path to the [IfcConvert](http://ifcopenshell.org/ifcconvert.html) executable |