Skip to content

Your first add on

Giorgio Garofalo edited this page Feb 9, 2021 · 24 revisions

Let's create our first add-on: head to {chorus dir}/addons and create a .js file named after your add-on's name (i.e. my-addon.js, see naming conventions below) and open it with any text editor.

Optionally (but highly recommended), define add-on information from code by overriding credits, version, description and image:

credits = 'iAmGio';
version = '1.0'; // Should not be omitted
description = 'Sample add-on';
image = 'https://i.imgur.com/JQvUs7b.png'; // Will be resized to 64x64

This information will be shown in the 'My add-ons' view.

Naming conventions

Add-on names should be lowercase with words separated by dashes.
Examples: my-addon, a-very-long-name.