obsidian-plugin/acylation_obsidian-click-clack
1
0
Fork 0
mirror of https://github.com/acylation/obsidian-click-clack.git synced 2026-07-22 09:50:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
28 commits 1 branch 4 tags 1.7 MiB
TypeScript 99.4%
JavaScript 0.6%
Find a file
Chiyu Liang 2a5a671164
Update README-ZH.md
2024-04-06 02:56:26 +08:00
.github Update FUNDING.yml 2024-04-01 04:24:02 +08:00
resources Upload new resources 2024-03-31 15:33:19 +08:00
src Eliminate global app and stop using node path 2024-04-04 17:05:10 +08:00
typings Add typings 2024-03-31 15:30:21 +08:00
.editorconfig Manual initial commit 2023-07-29 03:35:33 +08:00
.eslintignore Manual initial commit 2023-07-29 03:35:33 +08:00
.eslintrc Manual initial commit 2023-07-29 03:35:33 +08:00
.gitattributes Initial commit 2023-07-29 03:33:13 +08:00
.gitignore Manual initial commit 2023-07-29 03:35:33 +08:00
.npmrc Manual initial commit 2023-07-29 03:35:33 +08:00
.prettierignore Manual initial commit 2023-07-29 03:35:33 +08:00
.prettierrc Manual initial commit 2023-07-29 03:35:33 +08:00
esbuild.config.mjs Manual initial commit 2023-07-29 03:35:33 +08:00
LICENSE Upgrade deps and docs 2024-03-31 15:30:50 +08:00
manifest.json Bump to 0.1.2 2024-04-04 17:13:18 +08:00
package-lock.json Bump to 0.1.2 2024-04-04 17:13:18 +08:00
package.json Bump to 0.1.2 2024-04-04 17:13:18 +08:00
README-ZH.md Update README-ZH.md 2024-04-06 02:56:26 +08:00
README.md Update README.md 2024-04-06 02:55:54 +08:00
tsconfig.json Add i18n 2024-04-01 03:51:36 +08:00
version-bump.mjs Manual initial commit 2023-07-29 03:35:33 +08:00
versions.json Early configurations 2023-07-29 04:07:37 +08:00

README.md

Obsidian Click Clack

Obsidian Downloads

简体中文 | English

Simulates typewriter / mechanical keyboard sounds in Obsidian.

Note

Latest release: 0.1.2
Document version: 0.1.2

Installation

This plugin is still in early development. Currently it's unavailable from the plugin market. You can download this manually or using BRAT plugin.

Manually install

Go to the latest release page, download main.js and manifest.json and put the in the directory of [yourvault]/.obsidian/plugins/click-clack.

A default sound resource is bundled with the plugin. If you want more variants, you can find the Download button in the plugin's settings tab. Clicking it would fetch the resources.zip from the release page and unzip it to the directory of [yourvault]/.obsidian/plugins/click-clack/resources. You can also manually download and unzip the resources if there's error with automatical download.

Install via BRAT

You can add register this repo path in the BRAT plugin to install and get updated.

Configurations

In the plugin's settings tab, you can adjust sound volume for all keys, toggle on/off key sounds and select your favorite sound schemes.

You can also toggle on/off the key sounds via command palette (Ctrl + P), searching for enable click clack sound or disable click clack sound.

Credits

This project is based on forum discussion https://forum.obsidian.md/t/typewriter-sounds/15474, where contains many valuable design suggestions.

The first batch of sound schemes are taken from the Click Clack plugin of Writemonkey 3. Thank you so much for the charming resources!

Roadmap

  • Settings interface
    • Custom sources (common, return?, ping?,)
      • Recorder and sound editor integration / workflow
    • Adapt resources
      • Monkey type
      • Mechvibes
  • Handle controller chars
  • Handle non-editor region
    • include canvas md embed node