clarkwinkelmann/flarum-ext-clippy

Add Clippy agent to your forum.

Maintainers

Details

github.com/clarkwinkelmann/flarum-ext-clippy

Source

Issues

Forum

Installs: 145

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 3

Forks: 0

Open Issues: 0

Language:TypeScript

Type:flarum-extension

1.0.0 2021-06-11 02:26 UTC

Requires

MIT 9051618df41d6e90532c5baec68e2d818f65f70c

flarum

This package is auto-updated.

Last update: 2024-11-11 10:25:44 UTC

README

License Latest Stable Version Total Downloads Donate

This extension integrates the Clippy.js library by Smore into Flarum.

You can configure how Clippy should react to various actions on the forum with a combination of animation and/or speach bubble.

The default behavior from the library is preserved: Clippy can be moved around and has some default animations happening randomly and when clicking on it.

Installation

composer require clarkwinkelmann/flarum-ext-clippy

Changing the CDN

The extension does not embed the Clippy library for simplicity and also to avoid dealing with any of the licensing issues. You can choose where to load the files from using the CDN setting.

Amazon S3 (default): loads images and sounds from the S3 bucket maintained by Smore. The javascript and CSS is loaded from jsDelivr because it's not on the S3 bucket.

jsDelivr: all resources are loaded from jsDelivr using the automatic GitHub proxy.

Custom: you can choose the CDN URL yourself using the Custom CDN Path setting.

Steps to host locally:

  1. Download the ZIP file from this link.
  2. Extract the content of the file to <flarum>/public/assets.
  3. Rename the folder to clippy (it will likely be called smore-inc-clippy.js-8bfd1f9 after extraction).
  4. In the extension, set CDN to Custom and Custom CDN Path to /assets/clippy.
  5. If you want, you can delete the clippy/src folder, it's not actually used.

Support

This extension is under minimal maintenance.

It was developed for a client and released as open-source for the benefit of the community. I might publish simple bugfixes or compatibility updates for free.

You can contact me to sponsor additional features or updates.

Support is offered on a "best effort" basis through the Flarum community thread.

Links