Skip to content

Commit

Permalink
Update docs and remove styles.css
Browse files Browse the repository at this point in the history
  • Loading branch information
Acylation committed Mar 31, 2024
1 parent f0e0933 commit e172b6b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README-ZH.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Obsidian Typewriter Sounds
# Obsidian Click Clack

Simulates typewriter sounds in Obsidian.md
Obsidian 中模拟机械键盘、打字机按键音。
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,28 @@
# Obsidian Typewriter Sounds
# Obsidian Click Clack

Simulates typewriter sounds in Obsidian.md

source: <https://forum.obsidian.md/t/typewriter-sounds/15474>

This plugin is still in early development. Listen to key events and play typing sound effect through local resource.

You can install the plugin manully, and please include the unzipped resource folder to the plugin folder, that is ./obsidian/plugins/typewriter-sounds
## Install manually

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. However, if you want more variants, please download the `resources.zip` from the release and include the unzipped resource folder `resources` to the plugin folder.

## Roadmap

- Settings interface
- Custom sources (common, return?, ping?,)
- Monkey type
- Mechvibe
- Handle controller chars
- Documentation & Community
- i18n
- README-ZH.md
- Forum
- Forum-zh
- Discord
- Community plugin release
8 changes: 0 additions & 8 deletions styles.css

This file was deleted.

0 comments on commit e172b6b

Please sign in to comment.