https://github.com/laluxx/typetune

https://github.com/laluxx/typetune

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/laluxx/typetune
• Owner: laluxx
• Created: 2023-07-09T21:29:22.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-17T17:43:49.000Z (almost 2 years ago)
• Last Synced: 2025-01-03T04:14:47.621Z (5 months ago)
• Language: Python
• Size: 26.4 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

README

        
#+TITLE: Typetune

#+AUTHOR: laluxx

* Introduction

This project is a simple Python script that enhances your typing experience by playing custom keyboard sounds as you type. Each key press triggers a randomly chosen sound, simulating the feel of typing on a mechanical keyboard.

* Features

  - Dynamically loads sound files

  - Easily customizable with different sound themes

  - Exclude specific keys or key combinations from making sounds

  - uses same structure as osu skins, so there are alot of possible themes

* TODOs

- specific key combination sound like super + 1 or super + 2, so you can bind a specific sound when switching to a workspace in any window manager

- bind sound to a specific key like super

- bind sound to a specific key combination like super + shift

- variate the sound pith a little bit randomly so it feel more realistic

- exclude specific key combination to make sound

- add sound to : click, right click  and 

- as now you have to write the theme folder inside the src code, id like to make a config file in ~/.config/typetune/typetunerc or something, so it more scriptable

* Installation

** Requirements

   - Python 3

   - pygame library

   - pynput library

** Setup

   #+BEGIN_SRC shell

   git clone https://github.com/yourusername/typetune.git

   cd typetune

   yay -S python-pynput

   #+END_SRC

* Configuration

** Sounds

   Place your sound files inside the ~/xos/typetune/switches/theme_name/~ directory. The script dynamically loads all .ogg and .waw files in this directory.

** Excluded Keys

   You can exclude specific keys or key combinations from making sounds by editing the ~excluded_keys~ and ~excluded_combinations~ variables in the script. For example, to exclude the "h" key, add it to the ~excluded_keys~ list.

   #+BEGIN_SRC python

   excluded_keys = ["h", "j", "k", "l", "up", "right", "left", "down", "1", "2", "3", "4", "5", "6", "backspace", "enter", "shift", "ctrl", "cmd", "alt", "tab"]

   #+END_SRC

* Usage

   Run the script by executing the command below in your terminal:

   #+BEGIN_SRC shell

   python main.py

   #+END_SRC

* Contributing

   Feel free to fork the project and submit pull requests! Any contribution to improve the script or add new sound themes is appreciated.

* License

   This project is licensed under the MIT License. See the LICENSE file for details.