Open Brush Plugin Skill for Claude Code

An Agent Skill for Claude Code, Codex etc used for creating and modifying Lua plugins for Open Brush. This skill provides full access to the Open Brush Lua API documentation and assists with plugin development.

Features

• Complete Open Brush Lua API documentation included locally
• Real plugin examples from the Open Brush project
• Tutorials and guides for writing plugins
• Utility modules and helper libraries
• Fast local documentation access

Installation

Install this skill globally for use across all your projects:

git clone https://github.com/icosa-foundation/open-brush-plugin-skill.git ~/.claude/skills/open-brush-plugin-skill

The skill will be automatically available in Claude Code after installation.

Usage

Once installed, AI agents will automatically use this skill when you:

• Ask to create an Open Brush plugin
• Work with Lua scripts for Open Brush
• Ask about the Open Brush scripting API
• Request information about Lua functions or plugin development

Example Prompts

"Create a plugin that draws a spiral when I press the trigger"
"How do I get the current user position in Open Brush?"
"Write a plugin that colors strokes based on their layer"
"What functions are available in the Stroke class?"

What's Included

API Documentation (LuaDocs/)

Complete API reference for all Lua classes:

• Core Objects: App, Sketch, User, Tool, Headset, Spectator
• Spatial & Transformation: Transform, Vector2/3/4, Rotation, Path, Matrix
• Visual Elements: Brush, Stroke, Layer, Group, Color, Image, Video
• Environment & Scene: Environment, CameraPath, Guide, Model
• Advanced Features: Selection, Symmetry, Easing, Timer, Random, Math
• Utilities: Svg, Webrequest, Visualizer, Waveform

Tutorials & Guides (MainDocs/)

• Getting started with plugin development
• Writing different plugin types (Pointer, Symmetry, Tool, Background)
• Example walkthroughs and best practices

Example Plugins (Examples/)

Real Open Brush plugins demonstrating different techniques:

• BackgroundScript examples
• PointerScript examples
• SymmetryScript examples
• ToolScript examples

Utility Modules (LuaModules/)

• __autocomplete.lua - Complete list of valid API classes, methods, and properties
• lume.lua - Utility library
• Helper modules for plugin development

Updating

To get the latest API documentation and skill improvements:

cd ~/.claude/skills/open-brush-plugin-skill
git pull

The documentation in this repo is automatically synced from the official Open Brush plugin scripting docs.

Documentation Sources

All documentation is included locally in this skill:

• API Reference: ./LuaDocs/
• Tutorials: ./MainDocs/
• Examples: ./Examples/
• Modules: ./LuaModules/

External references:

• API Docs (GitHub): https://github.com/icosa-foundation/open-brush-plugin-scripting-docs
• Tutorials (GitHub): https://github.com/icosa-foundation/open-brush-docs
• Web Viewer: https://icosa.gitbook.io/open-brush-plugin-scripting-docs

Contributing

This skill is maintained by the Icosa Foundation. The API documentation is automatically synced from the source repositories.

For issues or suggestions:

• Skill issues: https://github.com/icosa-foundation/open-brush-plugin-skill/issues
• Documentation issues: https://github.com/icosa-foundation/open-brush-plugin-scripting-docs/issues

License

[Add appropriate license information]

About Open Brush

Open Brush is an open-source VR painting application. Learn more at:

• Website: https://openbrush.app
• GitHub: https://github.com/icosa-foundation/open-brush