This repository has been archived on 2026-10-29. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
geometry-script/book/src/introduction.md

28 lines
829 B
Markdown
Raw Normal View History

2022-11-15 12:59:28 -05:00
# Introduction
**Geometry Script** is a scripting API for Blender's Geometry Nodes.
It makes complicated node trees more managable and easy to share.
* [Full coverage of nodes](/available_nodes) available in your Blender version
* Clean, easy to use [Python API](#introduction)
* External [IDE integration](#introduction) for better completions and hot reload
Here's a simple example of what's possible with a short script:
### Geometry Script
```python
from geometry_script import *
@tree("Repeat Grid")
def repeat_grid(geometry: Geometry, width: Int, height: Int):
g = grid(
size_x=width, size_y=height,
vertices_x=width, vertices_y=height
).mesh_to_points()
return g.instance_on_points(instance=geometry)
```
### Generated Node Tree
![Generated node tree](images/example_generated_tree.png)