clarkwinkelmann/flarum-ext-typewriter

Plays custom sounds in the reply composer

Maintainers

Details

github.com/clarkwinkelmann/flarum-ext-typewriter

Source

Issues

Forum

Installs: 82

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 0

Language:TypeScript

Type:flarum-extension

1.0.0 2022-04-29 20:59 UTC

Requires

MIT 50cd2e6d8c1f4fd65ae02b0c448531dcadbb28ce

flarumsounds

This package is auto-updated.

Last update: 2024-10-29 06:19:19 UTC

README

MIT license Latest Stable Version Total Downloads Donate

This extension plays custom sounds while the user types in the Flarum reply composer.

A mute button is available in the top right of the composer. The mute setting is saved to the user profile, so it persists across sessions and browsers.

No sounds are embedded in the extension, you have to provide your own.

Format for the settings:

  • File: an absolute URL to a media file. You can skip the domain if hosted locally. For example: /assets/typewriter/keystroke.mp3 or https://cdn.mysite.tld/sound.ogg.
  • Keys: a regular expression to match a valid KeyboardEvent.code value. This expression will be passed to the constructor of javascript's RegExp so it does not need delimiters. If you are only matching one key, you can generally just enter the character in the field. To match multiple characters, use [abc] or [a-c]. Enter is Enter.

Installation

composer require clarkwinkelmann/flarum-ext-typewriter

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.

Sponsors: Billy Wilcosky (@010101)

Links