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 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.

Table Of Contents

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