@tarrasque/example-plugin

This is an example plugin for Tarrasque App, showcasing how to use the Tarrasque SDK to build your own plugins.

Overview

@tarrasque/example-plugin is a basic implementation designed to illustrate the fundamental concepts and functionalities available in the Tarrasque SDK. It includes event handling, custom dock elements, and event emission.

Features

• Event Listening: Shows the campaign name in the plugin's dock element.
• Dock Element Rendering: Provides a user interface element in the dock.
• Event Emission: Emits an event when the user interacts with the dock element.

Prerequisites

• Node.js (v18.12.1 or higher)
• pnpm (v8.8.0 or higher)

Setup

Run the following command to install dependencies:

pnpm install

Usage

To use the plugin in a development environment:

pnpm dev

This command lauches a local server and continuously recompiles the plugin on change. You can add this plugin to Tarrasque App by pointing it to https://tarrasqueapp.github.io/example-plugin/manifest.json in production, or http://localhost:5173/example-plugin/manifest-dev.json in development.