Home

Beat Plugin API Wiki

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 a single file (Plugin.beatPlugin) or live in a folder which contains a script file by the same name (ie. Plugin.beatPlugin/Plugin.beatPlugin or Plugin.beatPlugin/plugin.js). In the folder model, plugins can access supporting asset files, such as HTML templates.

The bare-bones sample plugins included in this repository demonstrate basic logic behind plugins. The best way learn plugin development is to study the existing, distributed plugins while reading 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! There's a ton of undocumented features, but I'm doing my best to keep this Wiki up to date.

Table Of Contents

• API overview (list of all available calls)
• Basics
  • Getting started
  • Accessing the editor
  • Document model
• HTML views
  • Displaying HTML content
• User interface (macOS only)
  • Modal windows and prompts
  • Menus
  • Widgets (experimental)
• Advanced
  • Saving user and document settings
  • Resident plugins and listeners
  • Providing autocompletion suggestions
  • Pagination
  • Preview data
  • Printing
  • File access
  • Revisions
• Very advanced
  • Parsing Fountain files
  • Background threading
• Plugin Guidelines