Using Plugins
Extend your ShapeBox scenes with community and custom plugins.
Using Plugins
Plugins let you add custom behaviour, interactions, and integrations to your ShapeBox scenes without writing complex code.
What is a plugin?
A ShapeBox plugin is a self-contained module that can:
- Add new object types or behaviours to the scene
- React to user interactions (clicks, proximity, input)
- Connect your scene to external APIs or data sources
- Create custom UI panels inside the editor
Installing a plugin from the Marketplace
- Open the Marketplace from the editor side panel or at marketplace.shapebox.io.
- Browse or search for the plugin you need.
- Click Install — the plugin is instantly available in your current project.
- In the editor, open the Plugins panel and drag the new plugin onto an object or into the scene root.
Configuring a plugin
Once a plugin is added to the scene:
- Select the object the plugin is attached to.
- In the Properties Panel, scroll to the Plugins section.
- Expand the plugin entry to view its settings.
- Adjust parameters (triggers, animations, data bindings) as needed.
Writing a custom plugin
For advanced use cases, you can write your own plugin using the ShapeBox Plugin SDK.
// example-plugin.js
export default {
name: 'Hello World',
version: '1.0.0',
onMount(scene, object) {
object.on('click', () => {
console.log('Hello from ShapeBox!')
})
},
}
Upload the file via Plugins → Upload Custom Plugin in the editor.
Next steps
- Read the full Plugin SDK reference.
- Share your plugin on the Marketplace.