For the complete documentation index, see llms.txt. This page is also available as Markdown.

Building an addon

What you’ll need

If you want to create an addon you will need will need to create and host a web application. We provide sample code to get you started in the following languages:

image-text

image-text

image-text

In this guide will cover the following topics, providing code examples where appropriate.

  1. Communicating with Squirrel and advising when the addon is ready to receive data

  2. Defining a default state

  3. Squirrel lifecycle hooks and events

  4. Receiving data from Squirrel

  5. Sending data to Squirrel

  6. Building a property panel

Alternatively you can download the sample projects and review them. We have packed them full of comments to explain how things work.

Last updated

Was this helpful?