> For the complete documentation index, see [llms.txt](https://docs.openbrush.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openbrush.app/user-guide/using-plugins/example-plugins/example-tool-plugins.md).

# Example Tool Plugins

### Circle

<div align="left"><figure><img src="/files/5yHeZn9ny6rKf90kjrDV" alt="" width="375"><figcaption></figcaption></figure></div>

Draws a circle centered on the position you first press the trigger with the radius and orientation controlled by where you release the trigger.

### Cube

<div align="left"><figure><img src="/files/owiZtLxMjjYORRyTLxMa" alt="" width="375"><figcaption></figcaption></figure></div>

Draws a cube centered on the position you first press the trigger with the size and orientation controlled by where you release the trigger.

#### Parameters

* **Point Spacing:** The distance between control points for the strokes that make up the cube
* **Inset Amount:** How much to inset each face towards it's center

### LowPolyLandscape

{% embed url="<https://www.youtube.com/watch?v=uRlrzk91QN4>" %}

Draws tiles that follow a hilly landscape as you hold the trigger.

#### Parameters

* **Scale:** The scale of the landscape. Smaller values make hills and valleys closer together
* **Height:** The height of the landscape (Controls the vertical scaling)
* **Offset:** The distance from the floor to position the landscape
* **Grid Size:** The size of the grid used. Bigger values are more "low poly"

### Platonic

Creates wireframe brushstrokes for any of the 5 Platonic solids (Tetrahedron, Cube, Octahedron, Dodecahedron, Icosahedron)

#### Parameters

(todo)

### RandomAvatar

{% embed url="<https://www.youtube.com/watch?v=S9TzdMAbAbU>" %}

Calls an API to generate a random SVG icon using the [MultiAvatar ](https://multiavatar.com/)library

### Rays

<div align="left"><figure><img src="/files/vaBuCfQe8srE1EYBmRMK" alt="" width="375"><figcaption></figcaption></figure></div>

Draws lines from the position you start drawing to your current position.

#### Parameters

* **Spacing:** How often to draw a new stroke

### ScatterCubes

<div align="left"><figure><img src="/files/2JaelrBFy11PZmYl73Bh" alt="" width="375"><figcaption></figcaption></figure></div>

Switches to the Hull Brush and draws cubes of random size and color as you move your brush",

#### Parameters

* **Maximum Size:** Controls how big the cubes can be
* **Spread:** Larger values allow cubes to be placed further from your brush position
* **Amount:** 0.5 gives a random 50/50 chance of creating a new cube each frame. Smaller values produce less cubes, larger values more.

### Spiral

<div align="left"><figure><img src="/files/4R9HWPsDNix1cPTV0Jed" alt="" width="375"><figcaption></figcaption></figure></div>

Draws a conical spiral.

#### Parameters

* **Number of turns:**
* **Number of steps per turn:**

### SpiralSphere

<div align="left"><figure><img src="/files/RDI1TD8fcIJ2tcD4b1UA" alt="" width="375"><figcaption></figcaption></figure></div>

Draws a spherical spiral.

#### Parameters

* **Steps:**
* **Turns:**

### SuperFormula

<div align="left"><figure><img src="/files/9LXAQ7wd2KTsSNs8NfDK" alt="" width="375"><figcaption></figcaption></figure></div>

Draws a supershape using the [Super Formula](http://paulbourke.net/geometry/supershape/)

#### Parameters

* **Symmetry:**
* **n1:**
* **n2:**
* **n3:**

### SvgHeart

<div align="left"><figure><img src="/files/PVQfVWtgQ9eUwIOq4R0f" alt="" width="375"><figcaption></figcaption></figure></div>

Draws a heart shape using an [SVG Path](https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths)

#### Parameters

* **Point Spacing:**

### TorusKnot

Draws a brush stroke forming a variety of interlocking knot shapes known as [Torus Knots](https://en.wikipedia.org/wiki/Torus_knot)

#### Parameters

(todo)

### VoxelLandscape

<div align="left"><figure><img src="/files/NrSm4kSB1vDbwicKUJNP" alt="" width="375"><figcaption></figcaption></figure></div>

Draws a blocky landscape (best used with a hull brush).

#### Parameters

* **Horizontal Spacing:**
* **Verticle Spacing:**

### Voxels

Draws regular blocks in space as you draw (best used with the hull brush)

<div align="left"><figure><img src="/files/6Dx7GknYfr1GJv7NOe3T" alt="" width="375"><figcaption></figcaption></figure></div>

#### Parameters

* **Grid Size:**

### Words

{% embed url="<https://www.youtube.com/watch?v=x-3K_0jT3Pg>" %}

Draws words that follows your brush. Tries to access the clipboard so try copying in some text.

#### Parameters

* **Size:**
* **Spacing:**


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openbrush.app/user-guide/using-plugins/example-plugins/example-tool-plugins.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.