new_object_walkthrough.md

Creating New Objects

Below is a list of all necessary changes to create a full package for a new object.

Object Code

In Core:

• Create a client file at include/clients/rt/{ObjectName}Client.hpp.
• Add a new line in FlucomaClients.cmake for {ObjectName}, referencing the client file from the previous step.
• If the client file becomes too bloated, separate the algorithm out into a new file at include/algorithms/public/{ObjectName}.hpp.

Documentation

In Docs:

• Create a reference file at doc/{ObjectName}.rst.

In Learn:

• Create a reference page. First, create a new folder at src/routes/(content)/reference/{ObjectName}/.
• Then, create +page.svx and {ObjectName}.svelte files in this folder. +page.svx will have the basic page content, and more specialised custom elements can be coded in the .svelte file.

In Max:

• Create a help patch for the object at help/{MaxObjectName}.maxhelp.
• If you need separate subpatchers for objects such as the poly~, place htem in the patchers/ folder.
• Add the object to the object list in the [Fluid Corpus Manipulation Toolkit](https://github.com/flucoma/flucoma-max/tree/main/extras/Fluid Corpus Manipulation Toolkit.maxpat) patch.

In SC:

In PD:

In CLI: