Documentation
Plugin Marketplace documentation
How PrusaSlicer plugins work, and everything you need to build, sign and publish your own. New here? Start with What a plugin is.
Getting started
- What a plugin is
What PrusaSlicer plugins do, how people install them and what the badges mean.
- Become an author
Create your author profile and find the author id your plugins carry.
Building a plugin
- Write your first plugin
Create a plugin with the PrusaSlicer CLI, see what its Lua file holds and run it in PrusaSlicer.
- Set up your editor
Add the Lua API stubs to your editor for completion, hover docs and type checks.
- The plugin bundle
What goes in the zip, the fields of manifest.json and which files are allowed.
- Signing keys
Create a key pair, register the public key and sign a bundle.
- Plugin ids and namespaces
Why a new plugin id needs a namespace, and how to get one with a domain or a GitHub account.
Publishing a plugin
- Publish from the author console
Upload a release by hand, follow its review and manage your plugin.
- Publishing from GitHub Actions
Publish a GitHub release and let a workflow sign and upload the plugin.
Reference
- Lua API
Every function and type a plugin can use, searchable, with the stubs for your editor.
- Slicer API (OpenAPI)
What PrusaSlicer reads: the catalogue, downloads and signature checks.
- Publish API (OpenAPI)
The upload endpoint the GitHub Action calls.