-
Notifications
You must be signed in to change notification settings - Fork 8
Home
Lauri-Matti Parppei edited this page Aug 31, 2022
·
33 revisions
Welcome to the Beat Plugin API wiki!
Beat provides a a simple API to interact with the app, so users can write their own plugins and extensions using JavaScript.
A plugin can be either contained a single file (Plugin.beatPlugin
) or live in a folder which contains a script file by the same name (ie. Plugin.beatPlugin/Plugin.beatPlugin
. In the folder model, plugins can access supporting asset files, such as HTML templates.
The sample plugins included in this repository demonstrate basic logic behind plugins. The best way learn plugin development is to study the existing ones and refer to this Wiki.
If you are planning on creating your own plugins and are confused by this documentation, drop by the Beat Discord and ask for tips and tricks.
- API overview (list of all available calls)
- Basics
- User interface
- Modal windows and prompts
- Displaying HTML content
- Widgets (experimental)
- Advanced
- Very advanced
- Plugin Guidelines