Contributing

Requirements

• Node.js 22 or later
• Intiface Central and a compatible device for manual device testing

Set Up a Local Plugin

Install dependencies and build the plugin:

npm install
npm run build

Add the built entry point to an opencode.json file in your project or ~/.config/opencode/opencode.json:

{
  "plugin": ["file:///absolute/path/to/opencode-plugin-buttplugio/dist/tui.js"]
}

Restart OpenCode after changing its configuration. Rebuild the plugin after source changes.

Validate Changes

Run the checks before opening a pull request:

npm run format:check
npm run typecheck
npm test
npm run lint
npm run build

Use npm run format to apply Prettier formatting and npm run lint:fix to apply ESLint fixes.

Submit Changes

Keep changes focused. Add or update tests when a behavior changes, and document user-visible configuration or command changes in both README files.