pi0/clippy provides a JavaScript library for embedding nostalgic animated assistants, such as Microsoft's Clippy, into any website. It targets web developers seeking to add interactive personality, visual flair, or a unique user experience to their applications, leveraging familiar characters for instant user recognition and engagement.

How It Works

This project is a client-side JavaScript library (clippyjs) that dynamically loads and animates character assets within a web page. Developers can import individual agents or a collection of them. The library exposes an API to control agent actions, including playing specific animations, displaying speech bubbles, moving the agent across the screen, and utilizing the Web Speech API for text-to-speech output with distinct voice personalities. All commands are queued and executed sequentially, enabling developers to chain complex interactions.

Quick Start & Requirements

• Primary install / run command:
  • CDN: Include via <script> tag in HTML.
  • npm: npm install clippyjs. Import initAgent and desired agents (e.g., import { Clippy } from "clippyjs/agents";).
• Non-default prerequisites and dependencies: Web browser environment. Text-to-Speech functionality requires browser support for the Web Speech API.
• Links: No specific demo or quick-start documentation links are provided beyond the usage examples in the README.

Highlighted Details

• Supports a variety of classic animated agents including Clippy, Bonzi, F1, Genie, Genius, Links, Merlin, Peedy, Rocky, and Rover.
• Offers a rich API for controlling animations (play, animate), speech (speak, speakStream), and agent positioning (moveTo).
• Features integrated Text-to-Speech (TTS) using the Web Speech API, with each agent possessing a unique voice personality.
• All agent actions are managed via a queue, ensuring sequential execution and allowing for chained commands.

Maintenance & Community

This project is described as a "fresh rewrite" utilizing agent data extracted via "Double Agent by Cinnamon Software." No specific details regarding active maintenance, contributor information, or community channels (like Discord or Slack) are present in the README.

Licensing & Compatibility

• License type: MIT for the code.
• Compatibility notes: Character assets are original creations of Microsoft and remain their property. While the MIT license permits broad use of the code, the underlying character IP may impose restrictions on commercial or derivative applications.

Limitations & Caveats

Text-to-Speech functionality is dependent on browser implementation of the Web Speech API. The ownership of character assets by Microsoft, despite the MIT license on the code, may present licensing complexities for certain deployment scenarios. Information regarding performance benchmarks, testing, or community engagement is not detailed in the provided documentation.