new-plugin

Duplicate TemplateProject to bootstrap a new iPlug2 plugin project.

152|37|Updated Feb 3, 2020
One-click install
npx skills add https://github.com/iPlug2/iPlug2OOS --skill new-plugin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: new-plugin
Source: https://github.com/iPlug2/iPlug2OOS/tree/main/.claude/skills/new-plugin
Command: npx skills add https://github.com/iPlug2/iPlug2OOS --skill new-plugin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables teams to bootstrap a new iPlug2 plugin project quickly by duplicating the TemplateProject in the iPlug2OOS repository, reducing setup time and ensuring consistency.

Core Features & Use Cases

  • One-click project bootstrap: Duplicates TemplateProject to create a ready-to-build plugin scaffolding.
  • Name and ID configuration: Guides you to set a plugin name, manufacturer, and IDs before first build.
  • Next steps: Provides instructions for committing changes and opening the project in Xcode.

Quick Start

Execute the duplication script with TemplateProject as the source and supply the PluginName and ManufacturerName: ./duplicate.py TemplateProject [PluginName] [ManufacturerName]

Frequently Asked Questions about new-plugin

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a new iPlug2 plugin project from the TemplateProject?

To bootstrap an iPlug2 plugin, run the duplicate.py script with TemplateProject as the source, passing your desired PluginName and ManufacturerName to generate ready-to-build scaffolding. This ensures consistent setup by automating project duplication and initial configuration.

What is the best way to duplicate an iPlug2 plugin for out-of-source development?

Duplicating an iPlug2 plugin is best handled by the duplicate.py script, which clones the TemplateProject inside the iPlug2OOS repository. This repeatable workflow handles naming conventions and IDs, ensuring consistent scaffolding across plugins.

Do I need to configure specific IDs and names when setting up an iPlug2 plugin?

Yes, when setting up an iPlug2 plugin, you must supply a PluginName and ManufacturerName. The bootstrap process validates these naming conventions to properly configure your project's identity before the first build.

Can I use the iPlug2OOS repository to bootstrap multiple plugins with consistent scaffolding?

Yes, you can use the iPlug2OOS repository to bootstrap multiple plugins. By duplicating the TemplateProject each time, the workflow enforces consistent scaffolding and automates naming validations across all newly created plugin projects.

What steps should I take after bootstrapping a new iPlug2 plugin project?

After bootstrapping an iPlug2 plugin project, your next steps are to commit the generated changes to version control and open the newly created project in Xcode to begin development.

Why does my iPlug2 plugin bootstrap fail during name validation?

Your iPlug2 plugin bootstrap fails during name validation if the supplied PluginName or ManufacturerName do not meet the required naming conventions. The duplication script validates these inputs to ensure proper project configuration before generating the scaffolding.