Kap currently supports three different types of services and a plugin can have multiple of each, although each plugin should focus on a specific area. Alternatively, you can run Kap in dev mode by downloading the source and running $ yarn start. In order to avoid any issues, make sure to run $ npm link after launching Kap, and make sure to re-run it if you restart Kap. When Kap is built for production, it prunes dependencies at launch time. In the directory of your plugin, run $ npm link, go to ~/Library/Application Support/Kap/plugins and run $ npm link plugin-name, and then add "plugin-name": "latest" to the "dependencies" in the package.json there. When you develop a plugin it’s useful to be able to try it out in Kap. This is still supported but will be removed at some point in favor of kap.version. Defaults to *.ĭeprecation notice: If your plugin only supports specific versions of Kap, include a kapVersion field in the package.json with a semver range. macosVersion: a semver range of the macOS versions your plugin supports.version: a semver range of the Kap versions your plugin supports.The package.json file can include a kap object with the following options: Your plugin must be tested, preferably using kap-plugin-test and kap-plugin-mock-context. The readme should follow the style of kap-giphy. Not something like this: Kap plugin that uploads GIFs to GIPHY. The "description" in package.json should succinctly describe what you can do with it. Add additional relevant keywords to improve discovery. You must have the kap-plugin keyword in package.json. Your package must be named with the kap- prefix. Tip: You can use modern JavaScript features like async/await in your plugin. Take a look at existing plugin examples in each section to see how they work. Kap plugins are published to npm, like any other npm package. That means you can use any npm package in your plugin. The plugin runs in the main Electron process (Node.js).
Getting startedĪ Kap plugin is an npm package that exports one or more services. You can discover plugins or view installed ones by clicking the Kap menu, Preferences…, and selecting the Plugins pane.
You could, for example, create a plugin to share a screen recording on YouTube. The Kap plugin system lets you create custom share targets that appear in the editor export menu.
0 kommentar(er)
