https://github.com/paireks/dotbim
Minimalist file format for BIM
https://github.com/paireks/dotbim
3d-models bim dotbim file-format
Last synced: about 1 year ago
JSON representation
Minimalist file format for BIM
- Host: GitHub
- URL: https://github.com/paireks/dotbim
- Owner: paireks
- License: mit
- Created: 2022-02-01T15:52:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-29T13:44:05.000Z (over 1 year ago)
- Last Synced: 2025-05-09T16:44:53.205Z (about 1 year ago)
- Topics: 3d-models, bim, dotbim, file-format
- Language: C#
- Homepage:
- Size: 11.4 MB
- Stars: 177
- Watchers: 22
- Forks: 22
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotbim (Schema version 1.1.0)
[](https://www.nuget.org/packages/dotbim/)
[](https://www.nuget.org/packages/dotbim/)
## Introduction
Introducing an open-source and minimalist file format for BIM. Built to be easy to read and write.
Created by BIM developers for BIM developers.
An idiot admires complexity, while a genius appreciates simplicity - Terry Davis
Website: https://www.dotbim.net
Quick introduction video: https://www.youtube.com/watch?v=RSV-0-UrzhQ
## BIM vs IFC comparison
| | .bim | .ifc |
| --------------------------- | ------------------------ | --------------------------------------------------------- |
| Is it open? | Yes | Yes |
| Is it free? | Yes | Yes |
| Type | Text file | Text file |
| What it contains | Geometry + data attached | Geometry + data attached in a standardized way |
| Types of geometries allowed | Triangulated meshes only | A lot of different types: meshes, extrusions, b-reps etc. |
| Pages of documentation | 1 | 100+ |
To see much more extended comparison check out Dion's comparison here: https://github.com/paireks/dotbim/issues/8
## Guide for developers
If you're a developer, check out this document: https://github.com/paireks/dotbim/blob/master/DeveloperTips.md
## Apps supporting .bim
(alphabetical order)
### Apps and libraries that support .bim files
| Name | Purpose | Link | Author |
| ---- | ------- | ---- | ------ |
| building3d | A wannabe framework for 3D modeling and simulation of buildings | https://github.com/krzysztofarendt/building3d | Krzysztof Arendt |
| kolega.space | Fully automated volume studies in a flash | https://www.kolega.space/ | Designbotic |
| Spacio | Lets you design, analyse, and bring to life properly structured building proposals – all within the same day. | https://spacio.ai/ | Spacio |
| topologicpy | An Advanced Spatial Modelling and Analysis Software Library for Architecture, Engineering, and Construction | https://topologic.app/ | Wassim Jabi |
| T-Rex | Reinforcement modelling | https://www.food4rhino.com/en/app/t-rex | Wojciech Radaczyński |
### Viewers and graphics SDKs that support .bim files
| Name | Purpose | Link | Author |
|------------------| ------- |---------------------------------------------------------------------------------| ------ |
| dotbim.three.js | Convert dotbim file to three.js object | [Click](https://github.com/ricaun/dotbim.three.js) | Luiz Henrique Cassettari |
| Online 3d Viewer | 3d viewer in browser | https://3dviewer.net/ | Viktor Kovacs, Agnes Gaschitz |
| STEP Viewer | 3d viewer in browser | [Click](https://githubdragonfly.github.io/viewers/templates/STEP%20Viewer.html) | GitHubDragonFly |
| xeokit | Web Programming Toolkit for AEC Graphics | https://xeokit.io/ | Lindsay Kay |
| xeo.vision | Engineering 3D BIM Viewer | https://xeo.vision/ | Creoox |
### Connectors - plugins that allow to export and/or import of .bim files to other software
| Name | Link | Author |
| ---- | ---- | ------ |
| dotbim-archicad | [Click](https://github.com/kovacsv/dotbim-archicad) | Viktor Kovacs |
| dotbim-blender | [Click](https://github.com/paireks/dotbim-blender) | Nathan Hild |
| DotBimConvert/RevitExporter | [Click](https://github.com/RyugaRyuzaki/DotBimConvert/tree/main/RevitExporter) | Ryuga Ryuzaki |
| dotbimGH | [Click](https://github.com/paireks/dotbimGH) | Wojciech Radaczyński |
| dotbimRH | [Click](https://github.com/seghier/DotBimRHImportExport) | Seghier Mohamed Abdelaziz |
| dotbim-Tekla | [Click](https://warehouse.tekla.com/#/catalog/details/a68b0576-e978-4cf8-b8bf-d196eb72a5f2) | Grzegorz Olszewski |
| import_dotbim | [Click](https://github.com/MattiaBressanelli/import_dotbim) | Mattia Bressanelli |
### Libraries for developers
| Name | Purpose | Link | Author |
| ---- | ------- | ---- | ------ |
| dotbim | Library written in C# language | you're looking at it right now ;) | Wojciech Radaczyński |
| dotbimpy | Library written in Python language | https://github.com/paireks/dotbimpy | Wojciech Radaczyński |
| dotbim_rust | Library written in Rust language | https://github.com/paireks/dotbim_rust | Wojciech Radaczyński |
| dotbim-ts | Library written in Typescript language | https://github.com/baid-group/dotbim-ts | Maciej Lutostański |
### Converters - programs that allow to convert to/from .bim files
| Name | Purpose | Link | Author |
| ---- | ------- | ---- | ------ |
| DotBimConvert/IFC | Converts from IFC | https://github.com/RyugaRyuzaki/DotBimConvert/tree/main/Ifc | Ryuga Ryuzaki |
| dotbim-ifc | Converts to and from IFC and dotbim | https://github.com/Moult/dotbim-ifc | Dion Moult |
| dotbim-io-dxf | Converts to and from 3d DXF and dotbim | https://github.com/Gorgious56/dotbim_io_dxf | Nathan Hild |
| mesh2mesh | Mac application with ability to convert from .dae, .obj, .ply, .scn, .stl, .usd, .usda, .usdz | https://apps.apple.com/us/app/mesh2mesh/id1672770477 | fluthaus |
| Online 3d Viewer | 3d viewer with ability of conversion from .obj, .3ds, .stl, .ply, .gltf, .glb, .off, .3dm, .fbx, .dae, .wrl, .3mf, .amf, .ifc, .brep, .step, .iges, .fcstd. | https://3dviewer.net/ | Viktor Kovacs, Agnes Gaschitz |
### Other projects related to .bim
| Name | Purpose | Link | Author |
| ---- | ------- | ---- | ------ |
| DotBimConvert/Compress | Compress and decompress .bim files | [Click](https://github.com/RyugaRyuzaki/DotBimConvert/tree/main/Compress) | Ryuga Ryuzaki |
| ICEBridge | Blender plugin to send BIM data to IDA ICE | [Click](https://github.com/maxtillberg/ICEBridge) | Max Tillberg |
| os4bim/dotbim | Converts Revit's detailed MEP to schematic 3d model | [Click](https://github.com/os4bim/dotbim) | Yoann Obry |
| three.model.bim | 3d modelling in browser | https://github.com/RyugaRyuzaki/three.model.bim | Ryuga Ryuzaki |
If you're building any app that will use .bim - let me know, I'll post it here :)
## NuGet package
https://www.nuget.org/packages/dotbim/
## Structure
## Documentation
### Main information
- .bim
- License: MIT
- JSON structure
- x, y, z coordinates should be in meters
- Decimal point should be used
- JSON objects and properties should start with lowercase and with underscore as a seperator between words, e.g. schema_version
### file
File contains 4 properties:
**schema_version** is the version of schema used in this file as string.
### mesh
**mesh_id** is integer >= 0 to reference this mesh later in the element.
#### coordinates
It is a big array of all coordinates of a mesh. It is structured in this way:
[X0, Y0, Z0, X1, Y1, Z1, X2, Y2, Z2, X3, Y3, Z3, ..., XN, YN, ZN]
Let's say our mesh is defined by 3 vertices: (0.0, 0.0, 0.0), (10.0, 0.0, 0.0) and (10.0, 5.0, 0.0), then your vertices_coordinates will look like this:
[0.0, 0.0, 0.0, 10.0, 0.0, 0.0, 10.0, 5.0, 0.0]
Later in faces_ids we refer to these vertices by their order.
#### indices
It is a big array of ids (integers) that define all faces in a mesh. It is structured in this way:
[Face1_Id1, Face1_Id2, Face1_Id3, Face2_Id1, Face2_Id2, Face3_Id3, Face3_Id1, Face3_Id2, Face3_Id3, ..., FaceN_Id1, FaceN_Id2, FaceN_Id3]
If we'd like to create one-face mesh using vertices_coordinates from an example above, then it will look like this:
[0, 1, 2]
Pyramid example:
```json
"coordinates": [
0.0,
0.0,
0.0,
10.0,
0.0,
0.0,
10.0,
10.0,
0.0,
0.0,
10.0,
0.0,
5.0,
5.0,
4.0
],
"indices": [
0,
1,
2,
0,
2,
3,
0,
1,
4,
1,
2,
4,
2,
3,
4,
3,
0,
4
]
```
### element
**guid** is a string that can be used for comparison of different elements.
```json
"guid": "76e051c1-1bd7-44fc-8e2e-db2b64055068"
```
#### vector
Vector places referenced mesh where it should be placed as an element. It should have 3 properties:
1. x (value)
2. y (value)
3. z (value)
```json
"vector": {
"x": 9.9266016462536122,
"y": 3.3910972817343494,
"z": 52.239445879618685
}
```
#### rotation
Rotation rotates referenced mesh how it should be rotated as element. It is a quaternion. It should have 4 properties:
1. qx (value) - first imaginary coefficient of the quaternion
2. qy (value) - second imaginary coefficient of the quaternion
3. qz (value) - third imaginary coefficient of the quaternion
4. qw (value) - real part of the quaternion
```json
"rotation": {
"qx": 0.63979295771454925,
"qy": 0.10626982147910254,
"qz": -0.12472093047736807,
"qw": -0.7508770776915008
}
```
#### color and face_colors
**From schema_version 1.1.0 if face_colors tag is applied, then we color element using face_colors, if there is no face_colors - we use color tag to color an element.**
color should have 3 properties:
1. r (integer between 0-255) - red
2. g (integer between 0-255) - green
3. b (integer between 0-255) - blue
4. a (integer between 0-255) - alpha
```json
"color": {
"r": 255,
"g": 255,
"b": 0,
"a": 255
}
```
To color single element with multiple colors add "face_colors" tag inside an element. "face_colors" is a simple list of integers (integers should be between 0-255) organised in that way:
[r1, g1, b1, a1, r2, g2, b2, a2, r3, g3, b3, a3, ... rn, gn, bn, an]
It should match each face of the mesh.
So let's say you have 3 faces inside one mesh, and wanted to color first face (triangle) as red (255,0,0,255), second as skyblue (135,206,235,255), third as white (255,255,255,255). Then you will have:
```json
"face_colors" : [ 255, 0, 0, 255, 135, 206, 235, 255, 255, 255, 255, 255 ]
```
#### type
Element type. It is a string that specifies what mesh represents. E.g. "Beam", "Plate".
```json
"type": "Beam"
```
### info
info is just a dictionary with string as key and value.
```json
"info": {
"Name": "Teapot",
"Price": "2.50$"
}
```
.bim file format encourages users to link their data by attaching URLs inside properties of file or specific elements. E.g.:
```json
"info": {
"Name": "Metal sheet roofing",
"Catalogue": "https://pruszynski.com.pl/t-20-roof,prod,99,2294.php"
}
```
Such functionality allows also to link one model with another as well.
If you're interested in this kind of linking, check this separate document about it: https://github.com/paireks/dotbim/blob/master/LinkingData.md
## Tell me more
If you'd like to read more details about this project, a bit background + line-by-line explanation, you might find this article on BIM Corner interesting: https://bimcorner.com/a-new-bim-file-format/
## Authors
- Wojciech Radaczyński
- Viktor Kovacs
## Advisors
- Tom Van Diggelen
- Harry Collin
- Marios Messios