Plugin Guidelines - lmparppei/BeatPlugins GitHub Wiki

Things to remember

  • Be Nice โ€“ don't make the user confused and try not to mess up their work. Test your plugins thoroughly, especially if they make any changes to the screenplay itself. Try to take edge cases into account.

  • Be Inclusive โ€“ avoid discriminatory language. For example, use women/men/other rather than male/female. Using gender-neutral pronouns (ie. they, hรคn, hen, etc.) is recommended when gender is ambiguous.

  • Preferrably distribute your plugins free of charge and make them open source. Nothing prevents you from making money out of custom plugins, but sharing your creations would be greatly appreciated! All official plugins are open source (MIT license) by default.

Plugin Info

If you want your plugin to be distributed, you should add a block of information at the beginning of your file:

/*

Name: Plugin Name
Copyright: Copyright Holder
Description: Single line description of what the plugin does
Version: 1.0
Type: Plugin Type
Compatibility: 1.920

<Description>
	<p>Simple HTML description for Plugin Library</p>
</Description>

*/

Version numbers should use ONLY numbers, and preferrably just a single dot, as in 1.1 or 2.12. If a more recent version of the plugin is available in this repository, the Plugin Manager will show an option to update it.

For Compatibility, always set the current version of Beat you are using. Current version can be found on both About dialog and on the starting menu when no documents are open.

Allowed plugin types are Tool, Export, Import and Standalone.

To get your plugin published in the Plugin Library, either submit a pull request, or send your plugin via e-mail: [email protected]