blender-geometry-script

A scripting API for Blender's Geometry Nodes:

add-on blender bpy geometry-nodes python scripting

Go to file

Carson Katri a360f26fde Add note about functions vs trees to node groups page		2022-11-20 18:09:08 -05:00
.github/workflows	Remove dot from directory	2022-11-15 13:10:31 -05:00
api	Support prefixes for InputGroups	2022-11-19 15:00:26 -05:00
book	Add note about functions vs trees to node groups page	2022-11-20 18:09:08 -05:00
examples	Update examples to use generated enums	2022-11-17 13:18:08 -05:00
.gitignore	Improve code generation and documentation	2022-11-13 14:38:31 -05:00
LICENSE	Create LICENSE	2022-11-13 14:53:08 -05:00
README.md	Add documentation link	2022-11-15 13:40:30 -05:00
__init__.py	Support generators and add City Builder example	2022-11-14 22:32:32 -05:00
absolute_path.py	Add default argument value support	2022-11-14 18:31:26 -05:00
external.py	Add helpers for working with external files and docs	2022-11-13 18:49:09 -05:00
preferences.py	Add helpers for working with external files and docs	2022-11-13 18:49:09 -05:00

README.md

A scripting API for Blender's Geometry Nodes:

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)

Installation

Download the source code
Open Blender > Preferences > Add-ons
Choose Install... and select the downloaded ZIP file

What is Geometry Script?

Geometry Script is a robust yet easy to use Python API for creating Geometry Nodes with code.

At a certain point, Geometry Node trees become unmanagably large. Creating node trees in Python enables quicker editing and reorganization of large, complex trees.

Geometry Script has all of the performance and capabilities of Geometry Nodes, but in a more managable format. The scripts are converted directly to Geometry Node trees making them easy to tweak for others unfamiliar with scripting.

Documentation

Read the documentation for more information on installation, syntax, and tutorials.