Skip to content

Commit

Permalink
Cleaning the github description
Browse files Browse the repository at this point in the history
  • Loading branch information
Durman committed Nov 21, 2023
1 parent 4c9cdcc commit d4c9dca
Showing 1 changed file with 3 additions and 69 deletions.
72 changes: 3 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,7 @@
# ๐Ÿ—๏ธ BuildingNodes

๐Ÿ  Tool for fast procedural building modeling | [Blender 3.0+](https://www.blender.org/) add-on ๐Ÿ 
# ๐Ÿ—๏ธ Building Nodes Documentation

[![BuildDocs](https://github.com/Durman/BuildingNodesDocs/actions/workflows/build_docs.yml/badge.svg)](https://github.com/Durman/BuildingNodesDocs/actions/workflows/build_docs.yml)

[**Documentation**](https://durman.github.io/BuildingNodesDocs/)

**Download - [Boosty][GR]**

[GR]: https://boosty.to/soluserg/posts/4c59f216-a966-4fa4-b141-056d86d8bbc6?share=post_link

Also, you can contact me in [Telegram](https://t.me/SoluSerg).

## Description

This is a tool for procedural generation of buildings. The work of the add-on
is similar to panel housing construction. The process is composed of three
steps:

1. Creating Panel. This should be done with standard Blender tools.
2. Creating building style. There is dedicated for this node tree editor.
3. Creating base mesh which will be turned into a building. It also should be
created with standard Blender modeling tools.

After the steps, a building style can be applied to a base mesh. Instead of
base mesh the add-on will create a building. Base mesh and building style can
be edited any moment and changes will be applied at once.

## Features
| ![figure](docs/images/Apply_style.gif) |
|:---:|
| Once building style was created it can be applied to as many objects as you wish. |
| ![figure](docs/images/Using_nodes.gif)|
| Using nodes for creating building styles. |
| ![figure](docs/images/Edit_facade.gif)|
| Editing buildings in real time. |
๐Ÿ  [**The add-on page**](https://github.com/Durman/BuildingNodes) ๐Ÿ 

**Advantages:**
- Ease of usage
- Achieve the same results with lesser nodes.
- The work of the add-on nodes is intuitively clearer. The abstraction of the
nodes is close to real world objects.
- No need in learning vector math, different algorithm of mesh processing and
data structure of a geometry.

## Limitations / Roadmap

- **macOS is currently [unsupported](https://github.com/Durman/BuildingNodesDocs/issues/5).**
- There are no any tools for roofs modeling.
- Using Geometry nodes for generating base meshes is currently [unsupported][1].
- Using Loop cut tool with live update makes Blender to [crush][2]. Using edge
crease tool also works weird.
- Custom properties per building and node groups [are not supported][3].
- [Base mesh][4] should consist only of quad polygons.
- Animation [is not supported][1].

[1]: https://durman.github.io/BuildingNodesDocs/execution_system.html
[2]: https://developer.blender.org/T67093
[3]: https://durman.github.io/BuildingNodesDocs/execution_system.html#tree-editor
[4]: https://durman.github.io/BuildingNodesDocs/data_structure.html#base-geometry

Some of this limitation should be gone in future versions.

## News

- **31.03.2022** Blender market [closed][5] the add-on page because PayPal put
sanctions on my account as I'm Russian citizen.
- **26.01.2022** The add-on was first published.

[5]: https://user-images.githubusercontent.com/28003269/161481199-7e69af6b-c4ae-4f23-981c-aa563a7c7789.png

https://user-images.githubusercontent.com/28003269/140365097-63408046-33dc-4fd8-8cbf-4f52fe9dc973.mp4
[**Documentation**](https://durman.github.io/BuildingNodesDocs/)

0 comments on commit d4c9dca

Please sign in to comment.