tuff plugin template

English | 简体中文

Features

• ⚡️ Tuff plugin template with a runnable dev UI (Vite + Vue).
• 🧩 Plugin entry (index.js) + manifest (manifest.json).
• 🦾 TypeScript types for plugin development.
• ⚙️ Typecheck with vue-tsc, unit tests with Vitest.

Try it now!

Requires Node >=22

GitHub Template

Create a repo from this template on GitHub.

Clone to local

If you prefer to do it manually with the cleaner git history

npx degit talex-touch/tuff-plugin-template my-tuff-plugin
cd my-tuff-plugin
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm

Checklist

When you use this template, update these fields first:

• Update plugin metadata in manifest.json (id, name, version, icon, description)
• Update features/commands in manifest.json
• Implement your logic in index.js (onFeatureTriggered)
• Update LICENSE author (if needed)
• Clean up the demo pages/routes if you don't need the dev UI

And, enjoy :)

Plan / PRD

See docs/PLAN_PRD.zh-CN.md.

Feature status

• ✅ touch-translate: implemented (mock translation in index.js)
• ⏳ multi-source-translate: placeholder (declared in manifest.json, not implemented yet)
• ⏳ screenshot-translate: placeholder (declared in manifest.json, not implemented yet)

Usage

Development

Run and visit http://localhost:3333

For Tuff dev mode, check manifest.json#dev (default: http://localhost:3333/#/).

pnpm dev

Build

To build the App, run

pnpm build

And you will see the generated file in dist that ready to be served.

Typecheck / Test

pnpm typecheck
pnpm test