Skip to content

How to generate plugins

Jump to bottom Edit New page
Pierre Guillot edited this page Jul 12, 2018 · 14 revisions

The Camomile plugins are a set of meta plugins. It means that the plugins of the distribution can't be directly loaded in a digital audio workstation but must be used to generate new plugins associated with Pure Data patches that will be loadable in the digital audio workstations.

Logo <\p>

The distribution contains a set of folders that can be used to generate plugins. This tutorial presents how to generate these examples but the approach will be the same for the plugins that you'll create.

Using the automatic script (since v1.0.6 for Linux and MacOS)

From the terminal application, run the camomile script located in distribution folder:

cd PATH_TO_THE_CAMOMILE_FOLDER
./camomile

By default, the script generates the plugins (in all the formats) for all the examples located in the Examples subfolder. So if you add a new plugin folder in the Examples subfolder, it will be generated. You can also use the facultative options:

  • -f PATH_TO_A_PLUGIN_FOLDER to generate a specific plugin. For example ./camomile -f ./Examples/Bulgroz generates the Bulgroz plugin only.
  • -d PATH_TO_A_DIRECTORY_CONTAINING_SEVERAL_PLUGIN_FOLDERS to generate all the plugin from a directory. For example ./camomile -d ./MyExamples generates all the plugins located in the subfolder MyExamples.
  • -o OUTPUT_PATH to specify the output folder. For example ./camomile -o ./MyPlugins outputs the plugins in the subfolder MyPlugins. You can also combine with one of the previous option. For example ./camomile -f ./Examples/Bulgroz -o ./MyBulgrozOutputFolder.

To display informations use the help command: ./camomile help.

Manual (all operating system)

MacOS users can also watch this tutorial.

  1. Open the Examples folder in the distribution. Each folder owns the patches and the informations of a plugin. tutorial 1 1

  2. Choose the folder of the plugin that you want to generate. tutorial 1 2

  3. Open the txt file that has the same name as the plugin and find the line that starts with type. tutorial 1 3

  4. If the type is effect, copy the CamomileFx plugin that you want to create (.dll, .lib, .vst, .vst3, or .component), otherwise if the type is instrument copy the Camomile plugin of your choice. tutorial 1 4

  5. Rename the Camomile plugin with the name of the plugin folder. tutorial 1 5

  6. Integrate the patches and the dependencies to the new plugin. The approach is slightly different depending on the operating system (Windows, MacOS and Linux) and the type (Audio Unit or VST).

    • Windows & Linux

      Copy the plugin (.dll, .vst3 or .lib) in the plugin folder. tutorial 1 6

    • MacOS

      Right click on the plugin (.vst, .vst3 or .component) and select Show Package Contents. tutorial 1 7

      Copy the content of the plugin folder in the Resources folder of the plugin package. tutorial 1 8

      Open the file Info.plist in a text editor , and change the values of the Bundle display name (<key>CFBundleDisplayName</key><string>value</string>) and the Bundle name (<key>CFBundleName</key><string>value</string>) to the name of the plugin. For example: <key>CFBundleDisplayName</key><string>Bulgroz</string> ... <key>CFBundleName</key><string>Bulgroz</string>. tutorial 1 14

      Specific to Audio Unit plugins (.component), the subtype value of the Info.plist must be changed to the code value defined in the text file of the plugin folder (see 3rd step). This value is a four characters string with at least one upper case character. And change the name value to the name of the plugin. tutorial 1 9

The plugin is ready to be used within a digital audio workstation. Please read the following section if you need help to install the plugin: How to install plugins.

Camomile needs your help, feel free to contribute to this wiki!

Camomile

Clone this wiki locally