Home

Beat Plugin API Wiki

Plugins are written in JavaScript. Beat provides a simple API to interact with the app.

A plugin can be either a single file (Plugin.beatPlugin) or a folder containing 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.

Table Of Contents

• Getting started
• Document model
• API overview
• Accessing the editor
• User input
• Displaying content
  • Standalone windows
• Resident plugins & listeners
• File Access
• Advanced
  • Parsing Fountain files
  • Multithreading
• Plugin Guidelines