View on GitHub

apkg

Advanced package manager for LeoConsole

Developing and packaging plugins

This is the documentation for how the package build process should work. For more info about the APIs and how to write your plugins refer to the LeoConsole wiki.

  1. Create your plugin repository. It is recommended to use the template.
  2. Write/edit your manifest.json.
  3. The manifest contains info about how to build the package. Build the package archive using apkg-builder or the build command in apkg (requires activating debug mode).
  4. Apkg-builder compiles your plugin, puts the files into a temporary build folder, generates a PKGINFO and compresses everything into a .lcp archive which can be installed using apkg.
  5. You can then add your plugin to the contrib repository by opening a pull request there.