https://github.com/carson-katri/geometry-script

A scripting API for Blender's Geometry Nodes
https://github.com/carson-katri/geometry-script

add-on blender bpy geometry-nodes python scripting

Last synced: about 1 month ago
JSON representation

A scripting API for Blender's Geometry Nodes

• Host: GitHub
• URL: https://github.com/carson-katri/geometry-script
• Owner: carson-katri
• License: gpl-3.0
• Created: 2022-11-13T19:51:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T11:20:26.000Z (7 months ago)
• Last Synced: 2025-04-03T15:09:14.355Z (about 2 months ago)
• Topics: add-on, blender, bpy, geometry-nodes, python, scripting
• Language: Python
• Homepage: https://carson-katri.github.io/geometry-script/
• Size: 20.8 MB
• Stars: 283
• Watchers: 9
• Forks: 27
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Geometry Script wordmark](book/src/images/wordmark.png)

A scripting API for Blender's Geometry Nodes:

```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.mesh_to_points()

    return g.instance_on_points(instance=geometry)

```

![Generated node tree](book/src/images/example_generated_tree.png)

## Installation

1. [Download the source code](https://github.com/carson-katri/geometry-script/archive/refs/heads/main.zip)

2. Open *Blender* > *Preferences* > *Add-ons*

3. Choose *Install...* and select the downloaded ZIP file

Or you can get it from the [Blender Market](https://www.blendermarket.com/products/geometry-script).

## 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](https://carson-katri.github.io/geometry-script/)

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