Typewriter Sounds

clarkwinkelmann

Typewriter Sounds

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

clarkwinkelmann

Umutcan yes you need to add your own sounds. Creating an assets/typewriter directory is a suggestion, you are free to place the files elsewhere or link them from off-site.

The extension was tested with some of these sounds converted to mp3 https://mixkit.co/free-sound-effects/typewriter/ There are also pre-made sounds in this third-party repository https://github.com/moos/taptapSfx But those aren't the only options, if you find other sound files you can use them as well.

From README:

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

010101

This looks like the greatest Flarum extension ever made. 😉

Proochles

Very cool!

Umutcan

I couldn't run it. My browser's audio permissions are turned on, I'm a mobile android chrome user.

clarkwinkelmann

Umutcan does it work on desktop? Does it work when the sound is set as default instead of specific letters?

If it never plays, there are debug messages that can be shown in the browser javascript console when debug mode is on that will help find what the issue is. It won't be easy to retrieve those messages on mobile though.

It might not work on all mobile browsers though, because it relies on the keydown event. I have not tested on mobile myself but I have reports that it works on iPhone.

010101

clarkwinkelmann I have reports that it works on iPhone.

Yes, it works on iPhone. Not sure about Android. But, usually if things work on desktop and an iPhone, it’s a safe bet it works on Android. Maybe @Umutcan just didn’t see how to unmute? On mobile, you have to minimize the composer, then you will see the speaker icon to unmute. Other than that, it could be something simple like the path to the audio file isn’t quite right. I would also add a default sound just in case. See if it works with just a single default sound.

Umutcan

010101

clarkwinkelmann

When I proceed on the site as follows, there is no sound file, should I add it? assets/typewriter/keystroke.mp3

clarkwinkelmann

It's also possible the audio file format is not supported by that particular device.

I have not implemented the ability to provide multiple audio types as fallback, but this can be added as sponsored work if anyone needs that feature. But with modern browsers I think it shouldn't be an issue to find a single file format that will work everywhere.