# clippyts

> Same old Clippy. Modern JavaScript.

Latest version **1.0.4** (published 2023-03-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install clippyts
pnpm add clippyts
yarn add clippyts
bun add clippyts
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-03-06 |
| First published | 2023-03-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 48.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 46 |
| Maintainers | lizozom |

## Links

- npm: https://www.npmjs.com/package/clippyts
- Repository: https://github.com/lizozom/clippyts
- Homepage: https://github.com/lizozom/clippyts#readme
- Issues: https://github.com/lizozom/clippyts/issues
- npm.io page: https://npm.io/package/clippyts

## Recent versions

- 1.0.4 (latest) — 2023-03-06
- 1.0.3 — 2023-03-05
- 1.0.2 — 2023-03-05
- 1.0.1 — 2023-03-05
- 1.0.0 — 2023-03-05

## README

# Clippy
> Add Clippy or his friends to any website for instant nostalgia.

## Demos

Please be patient for first load. It may take some time as agents are loaded one by one.

- [Simple JSFiddle](https://jsfiddle.net/pi0/rtw8p05k)
- [Agents Zoo](https://pi0.github.io/clippyjs/demo/index.html) 

![image](https://user-images.githubusercontent.com/5158436/27002340-c221cc06-4df4-11e7-9438-050a3ad8ecde.png)


## Usage


### NPM / Webpack

```
npm install clippyts
```

```ts
import clippy from 'clippyts'

clippy.load('Merlin', (agent: Agent) => {
    // do anything with the loaded agent
    agent.show();
});
```

## Actions
All the agent actions are queued and executed by order, so you could stack them.

```javascript
// play a given animation
agent.play('Searching');

// play a random animation
agent.animate();

// get a list of all the animations
agent.animations();
// => ["MoveLeft", "Congratulate", "Hide", "Pleased", "Acknowledge", ...]

// Show text balloon
agent.speak('When all else fails, bind some paper together. My name is Clippy.');

// move to the given point, use animation if available
agent.moveTo(100,100);

// gesture at a given point (if gesture animation is available)
agent.gestureAt(200,200);

// stop the current action in the queue
agent.stopCurrent();

// stop all actions in the queue and go back to idle mode
agent.stop();
```


# Licence
MIT

[FOSSA Status](https://app.fossa.com/projects/git%2Bgithub.com%2Flizozom%2Fclippyts?utm_source=share_link)

## Special Thanks
- [pi0 for the original clippyJS implementation](https://github.com/pi0/clippyjs)
- The [Clippy.JS](http://smore.com/clippy-js) project by [Smore](http://smore.com)
- The awesome [Cinnamon Software](http://www.cinnamonsoftware.com/) for developing [Double Agent](http://doubleagent.sourceforge.net/)
the program we used to unpack Clippy and his friends!
- Microsoft, for creating clippy :)

---
_Source: https://npm.io/package/clippyts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._