Adds the ability to play sounds while typing on any system.
Project description
Keyboard Sounds
This python package will add the ability to play sounds while typing anywhere on your system. You can also create Custom Profiles for customized audio when typing.
Preview Video
Click to view a preview of the application.
Installation
Python 3.7 or higher is required for this application to function. See Download Python for more information on installing Python on your system.
Once you have Python installed, you can install this application by running the following command.
$ pip install keyboardsounds
Platform Support
Windows | Linux | macOS |
---|---|---|
✅ Supported | ✅ Supported | ❓ Not Tested |
Default Sound Profiles
By default, Keyboard Sounds comes with the following profiles pre-loaded.
Name | Author | Description |
---|---|---|
alpaca | kbsim | Sample of an Alpaca Mechanical Keyboard |
gateron-black-ink | kbsim | Sample of Gateron Black Ink key switches |
gateron-red-ink | kbsim | Sample of Gateron Red Ink key switches |
holy-panda | kbsim | Sample of Holy Panda key switches |
ios | Apple, Inc. (Sampled) | Simulates the sounds made by an iPhone or iPad keyboard. |
mx-black | kbsim | Sample of Cherry MX Black key switches |
mx-blue | kbsim | Sample of Cherry MX Blue key switches |
mx-brown | kbsim | Sample of Cherry MX Brown key switches |
mx-speed-silver | Mechvibes Community | Sample audio of MX Speed Silver key switches |
telios-v2 | Mechvibes Community | Sample audio of Telios V2 linear key switches |
typewriter | Mechvibes Community | Sample audio of an antique typewriter |
Usage
Keyboard Sounds vX.X.X
usage:
manage daemon:
kbs start [-v <volume>] [-p <profile>]
kbs stop
kbs status
manage profiles:
kbs add-profile -z <zipfile>
kbs remove-profile -n <profile>
kbs list-profiles
kbs build-profile -d <sound_dir> -o <zip_file>
other:
kbs [--version|-V]
positional arguments:
{start,stop,status,add-profile,remove-profile,list-profiles,build-profile}
The action to perform
optional arguments:
-h, --help show this help message and exit
-v volume, --volume volume
volume of the sound effects (0-100), default 100
-p profile, --profile profile
sound profile to use, default 'ios'
-n name, --name name name of the profile remove
-z file, --zip file path to the zip file containing the profile to add
-V, --version show program's version number and exit
-d directory, --directory directory
path to the directory containing the sounds to use for the profile
-o file, --output file
path to the zip file to create
Manage Daemon
Start the daemon.
Can also be used to re-start the daemon with an adjusted configuration.
# Start with default volume of 100%
$ keyboardsounds start
# Start or reconfigure with a volume of 50%
$ keyboardsounds start -v 50
# Start or reconfigure with a specific profile
$ keyboardsounds start -p typewriter
Check the current status of the daemon.
$ keyboardsounds status
Stop the daemon if it is running.
$ keyboardsounds stop
Manage Profiles
Add a new profile to the application.
$ keyboardsounds add-profile -z ./my-profile.zip
Removes a profile from the application.
$ keyboardsounds remove-profile -n myprofile
Lists the currently loaded profiles.
$ keyboardsounds list-profiles
Custom Profiles
This application supports custom profiles in which you can provide your own WAV or MP3 files to be used for the different keys pressed.
Creating a Profile
- Create a new directory containing the sounds you wish to use.
- Add a new file to the directory called
profile.yaml
. - Follow the example format below to fill the file in.
- Combine the files into a ZIP file. The files must be at the root of the zip file.
You can then load this profile into the application using the add-profile
action.
Note: Alternately you can use the
build-profile
action for an environment with built in validation when creating a new profile.
Example Profile
# General information about your profile, this includes
# name, author and description.
#
# You are only required to provide the "name" field.
profile:
name: my-profile
author: Nathan Fiscaletti
description: Describe the sounds packaged in this profile
# A list of all audio sources used by this profile each
# containing an identifier and a source.
#
# The source can either be the name of an audio file
# packaged with this profile OR a dictionary with two
# keys, one 'press' and one 'release', who's
# corresponding values are names of audio files
# packaged with this profile.
sources:
- id: key1
source: sound1.wav
- id: key2
source:
press: sound2.wav
release: sound3.wav
# An optional mappings of audio sources to
# particular keys on the keyboard.
#
# If you chose to omit the keys section, each time
# a key is pressed on the keyboard a random sound
# from the list of audio sources will be used.
keys:
# The default value to use for any key not
# mapped elsewhere in the keys object.
#
# If you provide the keys object, you MUST
# provide a value for the default property.
#
# The value for this property can either be
# the ID of one of the sources you defined
# above, or an array of IDs.
default: [ key1, key2 ]
# A list of mappings of sources to keyboard keys.
other:
# The sound to play when one of the keys listed
# in the keys array is pressed.
#
# The value for this property can either be
# the ID of one of the sources you defined
# above, or an array of IDs.
- sound: key1
# An array of keys that you can press that this
# sound will be mapped to.
keys: [ backspace, delete ]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for keyboardsounds-5.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa2c593b0edd64a5d818f52164b4933b6ca4036e5afcd0fefe721d60b3adebab |
|
MD5 | cb1085e7e61e979924d389b927efcdbc |
|
BLAKE2b-256 | 9d09ac57feef81ad8fe81e8cda40ee29e83ea2f86a4fd4cf3078ae44df275a33 |