Skip to content
forked from pi0/clippyjs

Add Clippy or his friends to any website for instant nostalgia

License

Notifications You must be signed in to change notification settings

lizozom/clippyts

 
 

Repository files navigation

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.

clippy-agents

Usage

Demo

Run npm run demo to view the agent demo page.

NPM / Webpack

npm install clippyts
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.

// 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

Special Thanks

About

Add Clippy or his friends to any website for instant nostalgia

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.9%
  • Other 0.1%